public sealed class DataCatalogClientImpl : DataCatalogClient
Reference 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(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.
Parameters | |
---|---|
Name | Description |
grpcClient |
DataCatalogDataCatalogClient The underlying gRPC client. |
settings |
DataCatalogSettings The base DataCatalogSettings used within this client. |
logger |
ILogger Optional ILogger to use within this client. |
Properties
GrpcClient
public override DataCatalog.DataCatalogClient GrpcClient { get; }
The underlying gRPC DataCatalog client
Property Value | |
---|---|
Type | Description |
DataCatalogDataCatalogClient |
IAMPolicyClient
public override IAMPolicyClient IAMPolicyClient { get; }
The IAMPolicyClient associated with this client.
Property Value | |
---|---|
Type | Description |
IAMPolicyClient |
ImportEntriesOperationsClient
public override OperationsClient ImportEntriesOperationsClient { get; }
The long-running operations client for ImportEntries
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
ReconcileTagsOperationsClient
public override OperationsClient ReconcileTagsOperationsClient { get; }
The long-running operations client for ReconcileTags
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
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.
Parameters | |
---|---|
Name | Description |
request |
CreateEntryRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
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.
Parameters | |
---|---|
Name | Description |
request |
CreateEntryRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskEntry |
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.
Parameters | |
---|---|
Name | Description |
request |
CreateEntryGroupRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
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.
Parameters | |
---|---|
Name | Description |
request |
CreateEntryGroupRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskEntryGroup |
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.
Parameters | |
---|---|
Name | Description |
request |
CreateTagRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
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.
Parameters | |
---|---|
Name | Description |
request |
CreateTagRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskTag |
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.
Parameters | |
---|---|
Name | Description |
request |
CreateTagTemplateRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
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.
Parameters | |
---|---|
Name | Description |
request |
CreateTagTemplateRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskTagTemplate |
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.
Parameters | |
---|---|
Name | Description |
request |
CreateTagTemplateFieldRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
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.
Parameters | |
---|---|
Name | Description |
request |
CreateTagTemplateFieldRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskTagTemplateField |
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.
Parameters | |
---|---|
Name | Description |
request |
DeleteEntryRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If 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.
Parameters | |
---|---|
Name | Description |
request |
DeleteEntryRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
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.
Parameters | |
---|---|
Name | Description |
request |
DeleteEntryGroupRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If 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.
Parameters | |
---|---|
Name | Description |
request |
DeleteEntryGroupRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task |
A Task containing the RPC response. |
DeleteTag(DeleteTagRequest, CallSettings)
public override void DeleteTag(DeleteTagRequest request, CallSettings callSettings = null)
Deletes a tag.
Parameters | |
---|---|
Name | Description |
request |
DeleteTagRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
DeleteTagAsync(DeleteTagRequest, CallSettings)
public override Task DeleteTagAsync(DeleteTagRequest request, CallSettings callSettings = null)
Deletes a tag.
Parameters | |
---|---|
Name | Description |
request |
DeleteTagRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task |
A Task containing the RPC response. |
DeleteTagTemplate(DeleteTagTemplateRequest, CallSettings)
public override void DeleteTagTemplate(DeleteTagTemplateRequest request, CallSettings callSettings = null)
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.
Parameters | |
---|---|
Name | Description |
request |
DeleteTagTemplateRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
DeleteTagTemplateAsync(DeleteTagTemplateRequest, CallSettings)
public override Task DeleteTagTemplateAsync(DeleteTagTemplateRequest request, CallSettings callSettings = null)
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.
Parameters | |
---|---|
Name | Description |
request |
DeleteTagTemplateRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task |
A Task containing the RPC response. |
DeleteTagTemplateField(DeleteTagTemplateFieldRequest, CallSettings)
public override void DeleteTagTemplateField(DeleteTagTemplateFieldRequest request, CallSettings callSettings = null)
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.
Parameters | |
---|---|
Name | Description |
request |
DeleteTagTemplateFieldRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
DeleteTagTemplateFieldAsync(DeleteTagTemplateFieldRequest, CallSettings)
public override Task DeleteTagTemplateFieldAsync(DeleteTagTemplateFieldRequest request, CallSettings callSettings = null)
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.
Parameters | |
---|---|
Name | Description |
request |
DeleteTagTemplateFieldRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task |
A Task containing the RPC response. |
GetEntry(GetEntryRequest, CallSettings)
public override Entry GetEntry(GetEntryRequest request, CallSettings callSettings = null)
Gets an entry.
Parameters | |
---|---|
Name | Description |
request |
GetEntryRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Entry |
The RPC response. |
GetEntryAsync(GetEntryRequest, CallSettings)
public override Task<Entry> GetEntryAsync(GetEntryRequest request, CallSettings callSettings = null)
Gets an entry.
Parameters | |
---|---|
Name | Description |
request |
GetEntryRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskEntry |
A Task containing the RPC response. |
GetEntryGroup(GetEntryGroupRequest, CallSettings)
public override EntryGroup GetEntryGroup(GetEntryGroupRequest request, CallSettings callSettings = null)
Gets an entry group.
Parameters | |
---|---|
Name | Description |
request |
GetEntryGroupRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
EntryGroup |
The RPC response. |
GetEntryGroupAsync(GetEntryGroupRequest, CallSettings)
public override Task<EntryGroup> GetEntryGroupAsync(GetEntryGroupRequest request, CallSettings callSettings = null)
Gets an entry group.
Parameters | |
---|---|
Name | Description |
request |
GetEntryGroupRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskEntryGroup |
A Task containing the RPC response. |
GetIamPolicy(GetIamPolicyRequest, CallSettings)
public override Policy GetIamPolicy(GetIamPolicyRequest request, CallSettings callSettings = null)
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.
Parameters | |
---|---|
Name | Description |
request |
GetIamPolicyRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Policy |
The RPC response. |
GetIamPolicyAsync(GetIamPolicyRequest, CallSettings)
public override Task<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, CallSettings callSettings = null)
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.
Parameters | |
---|---|
Name | Description |
request |
GetIamPolicyRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskPolicy |
A Task containing the RPC response. |
GetTagTemplate(GetTagTemplateRequest, CallSettings)
public override TagTemplate GetTagTemplate(GetTagTemplateRequest request, CallSettings callSettings = null)
Gets a tag template.
Parameters | |
---|---|
Name | Description |
request |
GetTagTemplateRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TagTemplate |
The RPC response. |
GetTagTemplateAsync(GetTagTemplateRequest, CallSettings)
public override Task<TagTemplate> GetTagTemplateAsync(GetTagTemplateRequest request, CallSettings callSettings = null)
Gets a tag template.
Parameters | |
---|---|
Name | Description |
request |
GetTagTemplateRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskTagTemplate |
A Task containing the RPC response. |
ImportEntries(ImportEntriesRequest, CallSettings)
public override Operation<ImportEntriesResponse, ImportEntriesMetadata> ImportEntries(ImportEntriesRequest request, CallSettings callSettings = null)
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.
Parameters | |
---|---|
Name | Description |
request |
ImportEntriesRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
OperationImportEntriesResponseImportEntriesMetadata |
The RPC response. |
ImportEntriesAsync(ImportEntriesRequest, CallSettings)
public override Task<Operation<ImportEntriesResponse, ImportEntriesMetadata>> ImportEntriesAsync(ImportEntriesRequest request, CallSettings callSettings = null)
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.
Parameters | |
---|---|
Name | Description |
request |
ImportEntriesRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskOperationImportEntriesResponseImportEntriesMetadata |
A Task containing the RPC response. |
ListEntries(ListEntriesRequest, CallSettings)
public override PagedEnumerable<ListEntriesResponse, Entry> ListEntries(ListEntriesRequest request, CallSettings callSettings = null)
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].
Parameters | |
---|---|
Name | Description |
request |
ListEntriesRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerableListEntriesResponseEntry |
A pageable sequence of Entry resources. |
ListEntriesAsync(ListEntriesRequest, CallSettings)
public override PagedAsyncEnumerable<ListEntriesResponse, Entry> ListEntriesAsync(ListEntriesRequest request, CallSettings callSettings = null)
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].
Parameters | |
---|---|
Name | Description |
request |
ListEntriesRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerableListEntriesResponseEntry |
A pageable asynchronous sequence of Entry resources. |
ListEntryGroups(ListEntryGroupsRequest, CallSettings)
public override PagedEnumerable<ListEntryGroupsResponse, EntryGroup> ListEntryGroups(ListEntryGroupsRequest request, CallSettings callSettings = null)
Lists entry groups.
Parameters | |
---|---|
Name | Description |
request |
ListEntryGroupsRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerableListEntryGroupsResponseEntryGroup |
A pageable sequence of EntryGroup resources. |
ListEntryGroupsAsync(ListEntryGroupsRequest, CallSettings)
public override PagedAsyncEnumerable<ListEntryGroupsResponse, EntryGroup> ListEntryGroupsAsync(ListEntryGroupsRequest request, CallSettings callSettings = null)
Lists entry groups.
Parameters | |
---|---|
Name | Description |
request |
ListEntryGroupsRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerableListEntryGroupsResponseEntryGroup |
A pageable asynchronous sequence of EntryGroup resources. |
ListTags(ListTagsRequest, CallSettings)
public override PagedEnumerable<ListTagsResponse, Tag> ListTags(ListTagsRequest request, CallSettings callSettings = null)
Lists tags assigned to an [Entry][google.cloud.datacatalog.v1.Entry]. The [columns][google.cloud.datacatalog.v1.Tag.column] in the response are lowercased.
Parameters | |
---|---|
Name | Description |
request |
ListTagsRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerableListTagsResponseTag |
A pageable sequence of Tag resources. |
ListTagsAsync(ListTagsRequest, CallSettings)
public override PagedAsyncEnumerable<ListTagsResponse, Tag> ListTagsAsync(ListTagsRequest request, CallSettings callSettings = null)
Lists tags assigned to an [Entry][google.cloud.datacatalog.v1.Entry]. The [columns][google.cloud.datacatalog.v1.Tag.column] in the response are lowercased.
Parameters | |
---|---|
Name | Description |
request |
ListTagsRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerableListTagsResponseTag |
A pageable asynchronous sequence of Tag resources. |
LookupEntry(LookupEntryRequest, CallSettings)
public override Entry LookupEntry(LookupEntryRequest request, CallSettings callSettings = null)
Gets an entry by its target resource name.
The resource name comes from the source Google Cloud Platform service.
Parameters | |
---|---|
Name | Description |
request |
LookupEntryRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Entry |
The RPC response. |
LookupEntryAsync(LookupEntryRequest, CallSettings)
public override Task<Entry> LookupEntryAsync(LookupEntryRequest request, CallSettings callSettings = null)
Gets an entry by its target resource name.
The resource name comes from the source Google Cloud Platform service.
Parameters | |
---|---|
Name | Description |
request |
LookupEntryRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskEntry |
A Task containing the RPC response. |
ModifyEntryContacts(ModifyEntryContactsRequest, CallSettings)
public override Contacts ModifyEntryContacts(ModifyEntryContactsRequest request, CallSettings callSettings = null)
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.
Parameters | |
---|---|
Name | Description |
request |
ModifyEntryContactsRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Contacts |
The RPC response. |
ModifyEntryContactsAsync(ModifyEntryContactsRequest, CallSettings)
public override Task<Contacts> ModifyEntryContactsAsync(ModifyEntryContactsRequest request, CallSettings callSettings = null)
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.
Parameters | |
---|---|
Name | Description |
request |
ModifyEntryContactsRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskContacts |
A Task containing the RPC response. |
ModifyEntryOverview(ModifyEntryOverviewRequest, CallSettings)
public override EntryOverview ModifyEntryOverview(ModifyEntryOverviewRequest request, CallSettings callSettings = null)
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.
Parameters | |
---|---|
Name | Description |
request |
ModifyEntryOverviewRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
EntryOverview |
The RPC response. |
ModifyEntryOverviewAsync(ModifyEntryOverviewRequest, CallSettings)
public override Task<EntryOverview> ModifyEntryOverviewAsync(ModifyEntryOverviewRequest request, CallSettings callSettings = null)
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.
Parameters | |
---|---|
Name | Description |
request |
ModifyEntryOverviewRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskEntryOverview |
A Task containing the RPC response. |
ReconcileTags(ReconcileTagsRequest, CallSettings)
public override Operation<ReconcileTagsResponse, ReconcileTagsMetadata> ReconcileTags(ReconcileTagsRequest request, CallSettings callSettings = null)
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.
Parameters | |
---|---|
Name | Description |
request |
ReconcileTagsRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
OperationReconcileTagsResponseReconcileTagsMetadata |
The RPC response. |
ReconcileTagsAsync(ReconcileTagsRequest, CallSettings)
public override Task<Operation<ReconcileTagsResponse, ReconcileTagsMetadata>> ReconcileTagsAsync(ReconcileTagsRequest request, CallSettings callSettings = null)
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.
Parameters | |
---|---|
Name | Description |
request |
ReconcileTagsRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskOperationReconcileTagsResponseReconcileTagsMetadata |
A Task containing the RPC response. |
RenameTagTemplateField(RenameTagTemplateFieldRequest, CallSettings)
public override TagTemplateField RenameTagTemplateField(RenameTagTemplateFieldRequest request, CallSettings callSettings = null)
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.
Parameters | |
---|---|
Name | Description |
request |
RenameTagTemplateFieldRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TagTemplateField |
The RPC response. |
RenameTagTemplateFieldAsync(RenameTagTemplateFieldRequest, CallSettings)
public override Task<TagTemplateField> RenameTagTemplateFieldAsync(RenameTagTemplateFieldRequest request, CallSettings callSettings = null)
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.
Parameters | |
---|---|
Name | Description |
request |
RenameTagTemplateFieldRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskTagTemplateField |
A Task containing the RPC response. |
RenameTagTemplateFieldEnumValue(RenameTagTemplateFieldEnumValueRequest, CallSettings)
public override TagTemplateField RenameTagTemplateFieldEnumValue(RenameTagTemplateFieldEnumValueRequest request, CallSettings callSettings = null)
Renames an enum value in a tag template.
Within a single enum field, enum values must be unique.
Parameters | |
---|---|
Name | Description |
request |
RenameTagTemplateFieldEnumValueRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TagTemplateField |
The RPC response. |
RenameTagTemplateFieldEnumValueAsync(RenameTagTemplateFieldEnumValueRequest, CallSettings)
public override Task<TagTemplateField> RenameTagTemplateFieldEnumValueAsync(RenameTagTemplateFieldEnumValueRequest request, CallSettings callSettings = null)
Renames an enum value in a tag template.
Within a single enum field, enum values must be unique.
Parameters | |
---|---|
Name | Description |
request |
RenameTagTemplateFieldEnumValueRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskTagTemplateField |
A Task containing the RPC response. |
RetrieveConfig(RetrieveConfigRequest, CallSettings)
public override OrganizationConfig RetrieveConfig(RetrieveConfigRequest request, CallSettings callSettings = null)
Retrieves the configuration related to the migration from Data Catalog to Dataplex for a specific organization, including all the projects under it which have a separate configuration set.
Parameters | |
---|---|
Name | Description |
request |
RetrieveConfigRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
OrganizationConfig |
The RPC response. |
RetrieveConfigAsync(RetrieveConfigRequest, CallSettings)
public override Task<OrganizationConfig> RetrieveConfigAsync(RetrieveConfigRequest request, CallSettings callSettings = null)
Retrieves the configuration related to the migration from Data Catalog to Dataplex for a specific organization, including all the projects under it which have a separate configuration set.
Parameters | |
---|---|
Name | Description |
request |
RetrieveConfigRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskOrganizationConfig |
A Task containing the RPC response. |
RetrieveEffectiveConfig(RetrieveEffectiveConfigRequest, CallSettings)
public override MigrationConfig RetrieveEffectiveConfig(RetrieveEffectiveConfigRequest request, CallSettings callSettings = null)
Retrieves the effective configuration related to the migration from Data Catalog to Dataplex for a specific organization or project. If there is no specific configuration set for the resource, the setting is checked hierarchicahlly through the ancestors of the resource, starting from the resource itself.
Parameters | |
---|---|
Name | Description |
request |
RetrieveEffectiveConfigRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
MigrationConfig |
The RPC response. |
RetrieveEffectiveConfigAsync(RetrieveEffectiveConfigRequest, CallSettings)
public override Task<MigrationConfig> RetrieveEffectiveConfigAsync(RetrieveEffectiveConfigRequest request, CallSettings callSettings = null)
Retrieves the effective configuration related to the migration from Data Catalog to Dataplex for a specific organization or project. If there is no specific configuration set for the resource, the setting is checked hierarchicahlly through the ancestors of the resource, starting from the resource itself.
Parameters | |
---|---|
Name | Description |
request |
RetrieveEffectiveConfigRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskMigrationConfig |
A Task containing the RPC response. |
SearchCatalog(SearchCatalogRequest, CallSettings)
public override PagedEnumerable<SearchCatalogResponse, SearchCatalogResult> SearchCatalog(SearchCatalogRequest request, CallSettings callSettings = null)
Searches Data Catalog for multiple resources like entries and tags that match a query.
This is a Custom Method 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.
Parameters | |
---|---|
Name | Description |
request |
SearchCatalogRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerableSearchCatalogResponseSearchCatalogResult |
A pageable sequence of SearchCatalogResult resources. |
SearchCatalogAsync(SearchCatalogRequest, CallSettings)
public override PagedAsyncEnumerable<SearchCatalogResponse, SearchCatalogResult> SearchCatalogAsync(SearchCatalogRequest request, CallSettings callSettings = null)
Searches Data Catalog for multiple resources like entries and tags that match a query.
This is a Custom Method 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.
Parameters | |
---|---|
Name | Description |
request |
SearchCatalogRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerableSearchCatalogResponseSearchCatalogResult |
A pageable asynchronous sequence of SearchCatalogResult resources. |
SetConfig(SetConfigRequest, CallSettings)
public override MigrationConfig SetConfig(SetConfigRequest request, CallSettings callSettings = null)
Sets the configuration related to the migration to Dataplex for an organization or project.
Parameters | |
---|---|
Name | Description |
request |
SetConfigRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
MigrationConfig |
The RPC response. |
SetConfigAsync(SetConfigRequest, CallSettings)
public override Task<MigrationConfig> SetConfigAsync(SetConfigRequest request, CallSettings callSettings = null)
Sets the configuration related to the migration to Dataplex for an organization or project.
Parameters | |
---|---|
Name | Description |
request |
SetConfigRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskMigrationConfig |
A Task containing the RPC response. |
SetIamPolicy(SetIamPolicyRequest, CallSettings)
public override Policy SetIamPolicy(SetIamPolicyRequest request, CallSettings callSettings = null)
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.
Parameters | |
---|---|
Name | Description |
request |
SetIamPolicyRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Policy |
The RPC response. |
SetIamPolicyAsync(SetIamPolicyRequest, CallSettings)
public override Task<Policy> SetIamPolicyAsync(SetIamPolicyRequest request, CallSettings callSettings = null)
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.
Parameters | |
---|---|
Name | Description |
request |
SetIamPolicyRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskPolicy |
A Task containing the RPC response. |
StarEntry(StarEntryRequest, CallSettings)
public override StarEntryResponse StarEntry(StarEntryRequest request, CallSettings callSettings = null)
Marks an [Entry][google.cloud.datacatalog.v1.Entry] as starred by the current user. Starring information is private to each user.
Parameters | |
---|---|
Name | Description |
request |
StarEntryRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
StarEntryResponse |
The RPC response. |
StarEntryAsync(StarEntryRequest, CallSettings)
public override Task<StarEntryResponse> StarEntryAsync(StarEntryRequest request, CallSettings callSettings = null)
Marks an [Entry][google.cloud.datacatalog.v1.Entry] as starred by the current user. Starring information is private to each user.
Parameters | |
---|---|
Name | Description |
request |
StarEntryRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskStarEntryResponse |
A Task containing the RPC response. |
TestIamPermissions(TestIamPermissionsRequest, CallSettings)
public override TestIamPermissionsResponse TestIamPermissions(TestIamPermissionsRequest request, CallSettings callSettings = null)
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.
Parameters | |
---|---|
Name | Description |
request |
TestIamPermissionsRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TestIamPermissionsResponse |
The RPC response. |
TestIamPermissionsAsync(TestIamPermissionsRequest, CallSettings)
public override Task<TestIamPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRequest request, CallSettings callSettings = null)
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.
Parameters | |
---|---|
Name | Description |
request |
TestIamPermissionsRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskTestIamPermissionsResponse |
A Task containing the RPC response. |
UnstarEntry(UnstarEntryRequest, CallSettings)
public override UnstarEntryResponse UnstarEntry(UnstarEntryRequest request, CallSettings callSettings = null)
Marks an [Entry][google.cloud.datacatalog.v1.Entry] as NOT starred by the current user. Starring information is private to each user.
Parameters | |
---|---|
Name | Description |
request |
UnstarEntryRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
UnstarEntryResponse |
The RPC response. |
UnstarEntryAsync(UnstarEntryRequest, CallSettings)
public override Task<UnstarEntryResponse> UnstarEntryAsync(UnstarEntryRequest request, CallSettings callSettings = null)
Marks an [Entry][google.cloud.datacatalog.v1.Entry] as NOT starred by the current user. Starring information is private to each user.
Parameters | |
---|---|
Name | Description |
request |
UnstarEntryRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskUnstarEntryResponse |
A Task containing the RPC response. |
UpdateEntry(UpdateEntryRequest, CallSettings)
public override Entry UpdateEntry(UpdateEntryRequest request, CallSettings callSettings = null)
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.
Parameters | |
---|---|
Name | Description |
request |
UpdateEntryRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Entry |
The RPC response. |
UpdateEntryAsync(UpdateEntryRequest, CallSettings)
public override Task<Entry> UpdateEntryAsync(UpdateEntryRequest request, CallSettings callSettings = null)
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.
Parameters | |
---|---|
Name | Description |
request |
UpdateEntryRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskEntry |
A Task containing the RPC response. |
UpdateEntryGroup(UpdateEntryGroupRequest, CallSettings)
public override EntryGroup UpdateEntryGroup(UpdateEntryGroupRequest request, CallSettings callSettings = null)
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.
Parameters | |
---|---|
Name | Description |
request |
UpdateEntryGroupRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
EntryGroup |
The RPC response. |
UpdateEntryGroupAsync(UpdateEntryGroupRequest, CallSettings)
public override Task<EntryGroup> UpdateEntryGroupAsync(UpdateEntryGroupRequest request, CallSettings callSettings = null)
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.
Parameters | |
---|---|
Name | Description |
request |
UpdateEntryGroupRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskEntryGroup |
A Task containing the RPC response. |
UpdateTag(UpdateTagRequest, CallSettings)
public override Tag UpdateTag(UpdateTagRequest request, CallSettings callSettings = null)
Updates an existing tag.
Parameters | |
---|---|
Name | Description |
request |
UpdateTagRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Tag |
The RPC response. |
UpdateTagAsync(UpdateTagRequest, CallSettings)
public override Task<Tag> UpdateTagAsync(UpdateTagRequest request, CallSettings callSettings = null)
Updates an existing tag.
Parameters | |
---|---|
Name | Description |
request |
UpdateTagRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskTag |
A Task containing the RPC response. |
UpdateTagTemplate(UpdateTagTemplateRequest, CallSettings)
public override TagTemplate UpdateTagTemplate(UpdateTagTemplateRequest request, CallSettings callSettings = null)
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.
Parameters | |
---|---|
Name | Description |
request |
UpdateTagTemplateRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TagTemplate |
The RPC response. |
UpdateTagTemplateAsync(UpdateTagTemplateRequest, CallSettings)
public override Task<TagTemplate> UpdateTagTemplateAsync(UpdateTagTemplateRequest request, CallSettings callSettings = null)
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.
Parameters | |
---|---|
Name | Description |
request |
UpdateTagTemplateRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskTagTemplate |
A Task containing the RPC response. |
UpdateTagTemplateField(UpdateTagTemplateFieldRequest, CallSettings)
public override TagTemplateField UpdateTagTemplateField(UpdateTagTemplateFieldRequest request, CallSettings callSettings = null)
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.
Parameters | |
---|---|
Name | Description |
request |
UpdateTagTemplateFieldRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TagTemplateField |
The RPC response. |
UpdateTagTemplateFieldAsync(UpdateTagTemplateFieldRequest, CallSettings)
public override Task<TagTemplateField> UpdateTagTemplateFieldAsync(UpdateTagTemplateFieldRequest request, CallSettings callSettings = null)
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.
Parameters | |
---|---|
Name | Description |
request |
UpdateTagTemplateFieldRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskTagTemplateField |
A Task containing the RPC response. |