public abstract class DataCatalogClient
Reference documentation and code samples for the Data Catalog v1 API class DataCatalogClient.
DataCatalog client wrapper, for convenient use.
Derived Types
Namespace
Google.Cloud.DataCatalog.V1Assembly
Google.Cloud.DataCatalog.V1.dll
Remarks
Data Catalog API service allows you to discover, understand, and manage your data.
Properties
DefaultEndpoint
public static string DefaultEndpoint { get; }
The default endpoint for the DataCatalog service, which is a host of "datacatalog.googleapis.com" and a port of 443.
Property Value | |
---|---|
Type | Description |
string |
DefaultScopes
public static IReadOnlyList<string> DefaultScopes { get; }
The default DataCatalog scopes.
Property Value | |
---|---|
Type | Description |
IReadOnlyListstring |
The default DataCatalog scopes are:
GrpcClient
public virtual DataCatalog.DataCatalogClient GrpcClient { get; }
The underlying gRPC DataCatalog client
Property Value | |
---|---|
Type | Description |
DataCatalogDataCatalogClient |
IAMPolicyClient
public virtual IAMPolicyClient IAMPolicyClient { get; }
The IAMPolicyClient associated with this client.
Property Value | |
---|---|
Type | Description |
IAMPolicyClient |
ImportEntriesOperationsClient
public virtual OperationsClient ImportEntriesOperationsClient { get; }
The long-running operations client for ImportEntries
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
ReconcileTagsOperationsClient
public virtual OperationsClient ReconcileTagsOperationsClient { get; }
The long-running operations client for ReconcileTags
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
ServiceMetadata
public static ServiceMetadata ServiceMetadata { get; }
The service metadata associated with this client type.
Property Value | |
---|---|
Type | Description |
ServiceMetadata |
Methods
Create()
public static DataCatalogClient Create()
Synchronously creates a DataCatalogClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use DataCatalogClientBuilder.
Returns | |
---|---|
Type | Description |
DataCatalogClient | The created DataCatalogClient. |
CreateAsync(CancellationToken)
public static Task<DataCatalogClient> CreateAsync(CancellationToken cancellationToken = default)
Asynchronously creates a DataCatalogClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use DataCatalogClientBuilder.
Parameter | |
---|---|
Name | Description |
cancellationToken | CancellationToken The CancellationToken to use while creating the client. |
Returns | |
---|---|
Type | Description |
TaskDataCatalogClient | The task representing the created DataCatalogClient. |
CreateEntry(CreateEntryRequest, CallSettings)
public virtual 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. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
CreateEntryRequest request = new CreateEntryRequest
{
ParentAsEntryGroupName = EntryGroupName.FromProjectLocationEntryGroup("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]"),
Entry = new Entry(),
EntryId = "",
};
// Make the request
Entry response = dataCatalogClient.CreateEntry(request);
CreateEntry(EntryGroupName, string, Entry, CallSettings)
public virtual Entry CreateEntry(EntryGroupName parent, string entryId, Entry entry, 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 |
parent | EntryGroupName Required. The name of the entry group this entry belongs to. Note: The entry itself and its child resources might not be stored in the location specified in its name. |
entryId | string Required. The ID of the entry to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), and underscores (_). The maximum size is 64 bytes when encoded in UTF-8. |
entry | Entry Required. The entry to create. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Entry | The RPC response. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
EntryGroupName parent = EntryGroupName.FromProjectLocationEntryGroup("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]");
string entryId = "";
Entry entry = new Entry();
// Make the request
Entry response = dataCatalogClient.CreateEntry(parent, entryId, entry);
CreateEntry(string, string, Entry, CallSettings)
public virtual Entry CreateEntry(string parent, string entryId, Entry entry, 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 |
parent | string Required. The name of the entry group this entry belongs to. Note: The entry itself and its child resources might not be stored in the location specified in its name. |
entryId | string Required. The ID of the entry to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), and underscores (_). The maximum size is 64 bytes when encoded in UTF-8. |
entry | Entry Required. The entry to create. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Entry | The RPC response. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/entryGroups/[ENTRY_GROUP]";
string entryId = "";
Entry entry = new Entry();
// Make the request
Entry response = dataCatalogClient.CreateEntry(parent, entryId, entry);
CreateEntryAsync(CreateEntryRequest, CallSettings)
public virtual 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. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
CreateEntryRequest request = new CreateEntryRequest
{
ParentAsEntryGroupName = EntryGroupName.FromProjectLocationEntryGroup("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]"),
Entry = new Entry(),
EntryId = "",
};
// Make the request
Entry response = await dataCatalogClient.CreateEntryAsync(request);
CreateEntryAsync(CreateEntryRequest, CancellationToken)
public virtual Task<Entry> CreateEntryAsync(CreateEntryRequest request, CancellationToken cancellationToken)
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. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskEntry | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
CreateEntryRequest request = new CreateEntryRequest
{
ParentAsEntryGroupName = EntryGroupName.FromProjectLocationEntryGroup("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]"),
Entry = new Entry(),
EntryId = "",
};
// Make the request
Entry response = await dataCatalogClient.CreateEntryAsync(request);
CreateEntryAsync(EntryGroupName, string, Entry, CallSettings)
public virtual Task<Entry> CreateEntryAsync(EntryGroupName parent, string entryId, Entry entry, 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 |
parent | EntryGroupName Required. The name of the entry group this entry belongs to. Note: The entry itself and its child resources might not be stored in the location specified in its name. |
entryId | string Required. The ID of the entry to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), and underscores (_). The maximum size is 64 bytes when encoded in UTF-8. |
entry | Entry Required. The entry to create. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskEntry | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
EntryGroupName parent = EntryGroupName.FromProjectLocationEntryGroup("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]");
string entryId = "";
Entry entry = new Entry();
// Make the request
Entry response = await dataCatalogClient.CreateEntryAsync(parent, entryId, entry);
CreateEntryAsync(EntryGroupName, string, Entry, CancellationToken)
public virtual Task<Entry> CreateEntryAsync(EntryGroupName parent, string entryId, Entry entry, CancellationToken cancellationToken)
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 |
parent | EntryGroupName Required. The name of the entry group this entry belongs to. Note: The entry itself and its child resources might not be stored in the location specified in its name. |
entryId | string Required. The ID of the entry to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), and underscores (_). The maximum size is 64 bytes when encoded in UTF-8. |
entry | Entry Required. The entry to create. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskEntry | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
EntryGroupName parent = EntryGroupName.FromProjectLocationEntryGroup("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]");
string entryId = "";
Entry entry = new Entry();
// Make the request
Entry response = await dataCatalogClient.CreateEntryAsync(parent, entryId, entry);
CreateEntryAsync(string, string, Entry, CallSettings)
public virtual Task<Entry> CreateEntryAsync(string parent, string entryId, Entry entry, 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 |
parent | string Required. The name of the entry group this entry belongs to. Note: The entry itself and its child resources might not be stored in the location specified in its name. |
entryId | string Required. The ID of the entry to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), and underscores (_). The maximum size is 64 bytes when encoded in UTF-8. |
entry | Entry Required. The entry to create. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskEntry | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/entryGroups/[ENTRY_GROUP]";
string entryId = "";
Entry entry = new Entry();
// Make the request
Entry response = await dataCatalogClient.CreateEntryAsync(parent, entryId, entry);
CreateEntryAsync(string, string, Entry, CancellationToken)
public virtual Task<Entry> CreateEntryAsync(string parent, string entryId, Entry entry, CancellationToken cancellationToken)
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 |
parent | string Required. The name of the entry group this entry belongs to. Note: The entry itself and its child resources might not be stored in the location specified in its name. |
entryId | string Required. The ID of the entry to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), and underscores (_). The maximum size is 64 bytes when encoded in UTF-8. |
entry | Entry Required. The entry to create. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskEntry | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/entryGroups/[ENTRY_GROUP]";
string entryId = "";
Entry entry = new Entry();
// Make the request
Entry response = await dataCatalogClient.CreateEntryAsync(parent, entryId, entry);
CreateEntryGroup(LocationName, string, EntryGroup, CallSettings)
public virtual EntryGroup CreateEntryGroup(LocationName parent, string entryGroupId, EntryGroup entryGroup, 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 |
parent | LocationName Required. The names of the project and location that the new entry group belongs to. Note: The entry group itself and its child resources might not be stored in the location specified in its name. |
entryGroupId | string Required. The ID of the entry group to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and must start with a letter or underscore. The maximum size is 64 bytes when encoded in UTF-8. |
entryGroup | EntryGroup The entry group to create. Defaults to empty. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
EntryGroup | The RPC response. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
string entryGroupId = "";
EntryGroup entryGroup = new EntryGroup();
// Make the request
EntryGroup response = dataCatalogClient.CreateEntryGroup(parent, entryGroupId, entryGroup);
CreateEntryGroup(CreateEntryGroupRequest, CallSettings)
public virtual 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. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
CreateEntryGroupRequest request = new CreateEntryGroupRequest
{
ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
EntryGroup = new EntryGroup(),
EntryGroupId = "",
};
// Make the request
EntryGroup response = dataCatalogClient.CreateEntryGroup(request);
CreateEntryGroup(string, string, EntryGroup, CallSettings)
public virtual EntryGroup CreateEntryGroup(string parent, string entryGroupId, EntryGroup entryGroup, 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 |
parent | string Required. The names of the project and location that the new entry group belongs to. Note: The entry group itself and its child resources might not be stored in the location specified in its name. |
entryGroupId | string Required. The ID of the entry group to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and must start with a letter or underscore. The maximum size is 64 bytes when encoded in UTF-8. |
entryGroup | EntryGroup The entry group to create. Defaults to empty. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
EntryGroup | The RPC response. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
string entryGroupId = "";
EntryGroup entryGroup = new EntryGroup();
// Make the request
EntryGroup response = dataCatalogClient.CreateEntryGroup(parent, entryGroupId, entryGroup);
CreateEntryGroupAsync(LocationName, string, EntryGroup, CallSettings)
public virtual Task<EntryGroup> CreateEntryGroupAsync(LocationName parent, string entryGroupId, EntryGroup entryGroup, 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 |
parent | LocationName Required. The names of the project and location that the new entry group belongs to. Note: The entry group itself and its child resources might not be stored in the location specified in its name. |
entryGroupId | string Required. The ID of the entry group to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and must start with a letter or underscore. The maximum size is 64 bytes when encoded in UTF-8. |
entryGroup | EntryGroup The entry group to create. Defaults to empty. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskEntryGroup | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
string entryGroupId = "";
EntryGroup entryGroup = new EntryGroup();
// Make the request
EntryGroup response = await dataCatalogClient.CreateEntryGroupAsync(parent, entryGroupId, entryGroup);
CreateEntryGroupAsync(LocationName, string, EntryGroup, CancellationToken)
public virtual Task<EntryGroup> CreateEntryGroupAsync(LocationName parent, string entryGroupId, EntryGroup entryGroup, CancellationToken cancellationToken)
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 |
parent | LocationName Required. The names of the project and location that the new entry group belongs to. Note: The entry group itself and its child resources might not be stored in the location specified in its name. |
entryGroupId | string Required. The ID of the entry group to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and must start with a letter or underscore. The maximum size is 64 bytes when encoded in UTF-8. |
entryGroup | EntryGroup The entry group to create. Defaults to empty. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskEntryGroup | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
string entryGroupId = "";
EntryGroup entryGroup = new EntryGroup();
// Make the request
EntryGroup response = await dataCatalogClient.CreateEntryGroupAsync(parent, entryGroupId, entryGroup);
CreateEntryGroupAsync(CreateEntryGroupRequest, CallSettings)
public virtual 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. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
CreateEntryGroupRequest request = new CreateEntryGroupRequest
{
ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
EntryGroup = new EntryGroup(),
EntryGroupId = "",
};
// Make the request
EntryGroup response = await dataCatalogClient.CreateEntryGroupAsync(request);
CreateEntryGroupAsync(CreateEntryGroupRequest, CancellationToken)
public virtual Task<EntryGroup> CreateEntryGroupAsync(CreateEntryGroupRequest request, CancellationToken cancellationToken)
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. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskEntryGroup | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
CreateEntryGroupRequest request = new CreateEntryGroupRequest
{
ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
EntryGroup = new EntryGroup(),
EntryGroupId = "",
};
// Make the request
EntryGroup response = await dataCatalogClient.CreateEntryGroupAsync(request);
CreateEntryGroupAsync(string, string, EntryGroup, CallSettings)
public virtual Task<EntryGroup> CreateEntryGroupAsync(string parent, string entryGroupId, EntryGroup entryGroup, 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 |
parent | string Required. The names of the project and location that the new entry group belongs to. Note: The entry group itself and its child resources might not be stored in the location specified in its name. |
entryGroupId | string Required. The ID of the entry group to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and must start with a letter or underscore. The maximum size is 64 bytes when encoded in UTF-8. |
entryGroup | EntryGroup The entry group to create. Defaults to empty. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskEntryGroup | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
string entryGroupId = "";
EntryGroup entryGroup = new EntryGroup();
// Make the request
EntryGroup response = await dataCatalogClient.CreateEntryGroupAsync(parent, entryGroupId, entryGroup);
CreateEntryGroupAsync(string, string, EntryGroup, CancellationToken)
public virtual Task<EntryGroup> CreateEntryGroupAsync(string parent, string entryGroupId, EntryGroup entryGroup, CancellationToken cancellationToken)
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 |
parent | string Required. The names of the project and location that the new entry group belongs to. Note: The entry group itself and its child resources might not be stored in the location specified in its name. |
entryGroupId | string Required. The ID of the entry group to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and must start with a letter or underscore. The maximum size is 64 bytes when encoded in UTF-8. |
entryGroup | EntryGroup The entry group to create. Defaults to empty. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskEntryGroup | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
string entryGroupId = "";
EntryGroup entryGroup = new EntryGroup();
// Make the request
EntryGroup response = await dataCatalogClient.CreateEntryGroupAsync(parent, entryGroupId, entryGroup);
CreateTag(CreateTagRequest, CallSettings)
public virtual 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. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
CreateTagRequest request = new CreateTagRequest
{
ParentAsEntryName = EntryName.FromProjectLocationEntryGroupEntry("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]"),
Tag = new Tag(),
};
// Make the request
Tag response = dataCatalogClient.CreateTag(request);
CreateTag(EntryName, Tag, CallSettings)
public virtual Tag CreateTag(EntryName parent, Tag tag, 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 |
parent | EntryName Required. The name of the resource to attach this tag to. Tags can be attached to entries or entry groups. An entry can have up to 1000 attached tags. Note: The tag and its child resources might not be stored in the location specified in its name. |
tag | Tag Required. The tag to create. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Tag | The RPC response. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
EntryName parent = EntryName.FromProjectLocationEntryGroupEntry("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
Tag tag = new Tag();
// Make the request
Tag response = dataCatalogClient.CreateTag(parent, tag);
CreateTag(string, Tag, CallSettings)
public virtual Tag CreateTag(string parent, Tag tag, 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 |
parent | string Required. The name of the resource to attach this tag to. Tags can be attached to entries or entry groups. An entry can have up to 1000 attached tags. Note: The tag and its child resources might not be stored in the location specified in its name. |
tag | Tag Required. The tag to create. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Tag | The RPC response. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/entryGroups/[ENTRY_GROUP]/entries/[ENTRY]";
Tag tag = new Tag();
// Make the request
Tag response = dataCatalogClient.CreateTag(parent, tag);
CreateTagAsync(CreateTagRequest, CallSettings)
public virtual 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. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
CreateTagRequest request = new CreateTagRequest
{
ParentAsEntryName = EntryName.FromProjectLocationEntryGroupEntry("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]"),
Tag = new Tag(),
};
// Make the request
Tag response = await dataCatalogClient.CreateTagAsync(request);
CreateTagAsync(CreateTagRequest, CancellationToken)
public virtual Task<Tag> CreateTagAsync(CreateTagRequest request, CancellationToken cancellationToken)
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. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskTag | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
CreateTagRequest request = new CreateTagRequest
{
ParentAsEntryName = EntryName.FromProjectLocationEntryGroupEntry("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]"),
Tag = new Tag(),
};
// Make the request
Tag response = await dataCatalogClient.CreateTagAsync(request);
CreateTagAsync(EntryName, Tag, CallSettings)
public virtual Task<Tag> CreateTagAsync(EntryName parent, Tag tag, 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 |
parent | EntryName Required. The name of the resource to attach this tag to. Tags can be attached to entries or entry groups. An entry can have up to 1000 attached tags. Note: The tag and its child resources might not be stored in the location specified in its name. |
tag | Tag Required. The tag to create. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskTag | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
EntryName parent = EntryName.FromProjectLocationEntryGroupEntry("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
Tag tag = new Tag();
// Make the request
Tag response = await dataCatalogClient.CreateTagAsync(parent, tag);
CreateTagAsync(EntryName, Tag, CancellationToken)
public virtual Task<Tag> CreateTagAsync(EntryName parent, Tag tag, CancellationToken cancellationToken)
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 |
parent | EntryName Required. The name of the resource to attach this tag to. Tags can be attached to entries or entry groups. An entry can have up to 1000 attached tags. Note: The tag and its child resources might not be stored in the location specified in its name. |
tag | Tag Required. The tag to create. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskTag | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
EntryName parent = EntryName.FromProjectLocationEntryGroupEntry("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
Tag tag = new Tag();
// Make the request
Tag response = await dataCatalogClient.CreateTagAsync(parent, tag);
CreateTagAsync(string, Tag, CallSettings)
public virtual Task<Tag> CreateTagAsync(string parent, Tag tag, 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 |
parent | string Required. The name of the resource to attach this tag to. Tags can be attached to entries or entry groups. An entry can have up to 1000 attached tags. Note: The tag and its child resources might not be stored in the location specified in its name. |
tag | Tag Required. The tag to create. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskTag | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/entryGroups/[ENTRY_GROUP]/entries/[ENTRY]";
Tag tag = new Tag();
// Make the request
Tag response = await dataCatalogClient.CreateTagAsync(parent, tag);
CreateTagAsync(string, Tag, CancellationToken)
public virtual Task<Tag> CreateTagAsync(string parent, Tag tag, CancellationToken cancellationToken)
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 |
parent | string Required. The name of the resource to attach this tag to. Tags can be attached to entries or entry groups. An entry can have up to 1000 attached tags. Note: The tag and its child resources might not be stored in the location specified in its name. |
tag | Tag Required. The tag to create. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskTag | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/entryGroups/[ENTRY_GROUP]/entries/[ENTRY]";
Tag tag = new Tag();
// Make the request
Tag response = await dataCatalogClient.CreateTagAsync(parent, tag);
CreateTagTemplate(LocationName, string, TagTemplate, CallSettings)
public virtual TagTemplate CreateTagTemplate(LocationName parent, string tagTemplateId, TagTemplate tagTemplate, 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 |
parent | LocationName Required. The name of the project and the template location region. |
tagTemplateId | string Required. The ID of the tag template to create. The ID must contain only lowercase letters (a-z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum size is 64 bytes when encoded in UTF-8. |
tagTemplate | TagTemplate Required. The tag template to create. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TagTemplate | The RPC response. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
string tagTemplateId = "";
TagTemplate tagTemplate = new TagTemplate();
// Make the request
TagTemplate response = dataCatalogClient.CreateTagTemplate(parent, tagTemplateId, tagTemplate);
CreateTagTemplate(CreateTagTemplateRequest, CallSettings)
public virtual 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. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
CreateTagTemplateRequest request = new CreateTagTemplateRequest
{
ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
TagTemplate = new TagTemplate(),
TagTemplateId = "",
};
// Make the request
TagTemplate response = dataCatalogClient.CreateTagTemplate(request);
CreateTagTemplate(string, string, TagTemplate, CallSettings)
public virtual TagTemplate CreateTagTemplate(string parent, string tagTemplateId, TagTemplate tagTemplate, 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 |
parent | string Required. The name of the project and the template location region. |
tagTemplateId | string Required. The ID of the tag template to create. The ID must contain only lowercase letters (a-z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum size is 64 bytes when encoded in UTF-8. |
tagTemplate | TagTemplate Required. The tag template to create. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TagTemplate | The RPC response. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
string tagTemplateId = "";
TagTemplate tagTemplate = new TagTemplate();
// Make the request
TagTemplate response = dataCatalogClient.CreateTagTemplate(parent, tagTemplateId, tagTemplate);
CreateTagTemplateAsync(LocationName, string, TagTemplate, CallSettings)
public virtual Task<TagTemplate> CreateTagTemplateAsync(LocationName parent, string tagTemplateId, TagTemplate tagTemplate, 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 |
parent | LocationName Required. The name of the project and the template location region. |
tagTemplateId | string Required. The ID of the tag template to create. The ID must contain only lowercase letters (a-z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum size is 64 bytes when encoded in UTF-8. |
tagTemplate | TagTemplate Required. The tag template to create. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskTagTemplate | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
string tagTemplateId = "";
TagTemplate tagTemplate = new TagTemplate();
// Make the request
TagTemplate response = await dataCatalogClient.CreateTagTemplateAsync(parent, tagTemplateId, tagTemplate);
CreateTagTemplateAsync(LocationName, string, TagTemplate, CancellationToken)
public virtual Task<TagTemplate> CreateTagTemplateAsync(LocationName parent, string tagTemplateId, TagTemplate tagTemplate, CancellationToken cancellationToken)
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 |
parent | LocationName Required. The name of the project and the template location region. |
tagTemplateId | string Required. The ID of the tag template to create. The ID must contain only lowercase letters (a-z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum size is 64 bytes when encoded in UTF-8. |
tagTemplate | TagTemplate Required. The tag template to create. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskTagTemplate | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
string tagTemplateId = "";
TagTemplate tagTemplate = new TagTemplate();
// Make the request
TagTemplate response = await dataCatalogClient.CreateTagTemplateAsync(parent, tagTemplateId, tagTemplate);
CreateTagTemplateAsync(CreateTagTemplateRequest, CallSettings)
public virtual 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. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
CreateTagTemplateRequest request = new CreateTagTemplateRequest
{
ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
TagTemplate = new TagTemplate(),
TagTemplateId = "",
};
// Make the request
TagTemplate response = await dataCatalogClient.CreateTagTemplateAsync(request);
CreateTagTemplateAsync(CreateTagTemplateRequest, CancellationToken)
public virtual Task<TagTemplate> CreateTagTemplateAsync(CreateTagTemplateRequest request, CancellationToken cancellationToken)
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. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskTagTemplate | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
CreateTagTemplateRequest request = new CreateTagTemplateRequest
{
ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
TagTemplate = new TagTemplate(),
TagTemplateId = "",
};
// Make the request
TagTemplate response = await dataCatalogClient.CreateTagTemplateAsync(request);
CreateTagTemplateAsync(string, string, TagTemplate, CallSettings)
public virtual Task<TagTemplate> CreateTagTemplateAsync(string parent, string tagTemplateId, TagTemplate tagTemplate, 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 |
parent | string Required. The name of the project and the template location region. |
tagTemplateId | string Required. The ID of the tag template to create. The ID must contain only lowercase letters (a-z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum size is 64 bytes when encoded in UTF-8. |
tagTemplate | TagTemplate Required. The tag template to create. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskTagTemplate | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
string tagTemplateId = "";
TagTemplate tagTemplate = new TagTemplate();
// Make the request
TagTemplate response = await dataCatalogClient.CreateTagTemplateAsync(parent, tagTemplateId, tagTemplate);
CreateTagTemplateAsync(string, string, TagTemplate, CancellationToken)
public virtual Task<TagTemplate> CreateTagTemplateAsync(string parent, string tagTemplateId, TagTemplate tagTemplate, CancellationToken cancellationToken)
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 |
parent | string Required. The name of the project and the template location region. |
tagTemplateId | string Required. The ID of the tag template to create. The ID must contain only lowercase letters (a-z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum size is 64 bytes when encoded in UTF-8. |
tagTemplate | TagTemplate Required. The tag template to create. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskTagTemplate | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
string tagTemplateId = "";
TagTemplate tagTemplate = new TagTemplate();
// Make the request
TagTemplate response = await dataCatalogClient.CreateTagTemplateAsync(parent, tagTemplateId, tagTemplate);
CreateTagTemplateField(CreateTagTemplateFieldRequest, CallSettings)
public virtual 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. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
CreateTagTemplateFieldRequest request = new CreateTagTemplateFieldRequest
{
ParentAsTagTemplateName = TagTemplateName.FromProjectLocationTagTemplate("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]"),
TagTemplateFieldId = "",
TagTemplateField = new TagTemplateField(),
};
// Make the request
TagTemplateField response = dataCatalogClient.CreateTagTemplateField(request);
CreateTagTemplateField(TagTemplateName, string, TagTemplateField, CallSettings)
public virtual TagTemplateField CreateTagTemplateField(TagTemplateName parent, string tagTemplateFieldId, TagTemplateField tagTemplateField, 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 |
parent | TagTemplateName Required. The name of the project and the template location region. |
tagTemplateFieldId | string Required. The ID of the tag template field to create. Note: Adding a required field to an existing template is not allowed. Field IDs can contain letters (both uppercase and lowercase), numbers (0-9), underscores (_) and dashes (-). Field IDs must be at least 1 character long and at most 128 characters long. Field IDs must also be unique within their template. |
tagTemplateField | TagTemplateField Required. The tag template field to create. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TagTemplateField | The RPC response. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
TagTemplateName parent = TagTemplateName.FromProjectLocationTagTemplate("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]");
string tagTemplateFieldId = "";
TagTemplateField tagTemplateField = new TagTemplateField();
// Make the request
TagTemplateField response = dataCatalogClient.CreateTagTemplateField(parent, tagTemplateFieldId, tagTemplateField);
CreateTagTemplateField(string, string, TagTemplateField, CallSettings)
public virtual TagTemplateField CreateTagTemplateField(string parent, string tagTemplateFieldId, TagTemplateField tagTemplateField, 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 |
parent | string Required. The name of the project and the template location region. |
tagTemplateFieldId | string Required. The ID of the tag template field to create. Note: Adding a required field to an existing template is not allowed. Field IDs can contain letters (both uppercase and lowercase), numbers (0-9), underscores (_) and dashes (-). Field IDs must be at least 1 character long and at most 128 characters long. Field IDs must also be unique within their template. |
tagTemplateField | TagTemplateField Required. The tag template field to create. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TagTemplateField | The RPC response. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/tagTemplates/[TAG_TEMPLATE]";
string tagTemplateFieldId = "";
TagTemplateField tagTemplateField = new TagTemplateField();
// Make the request
TagTemplateField response = dataCatalogClient.CreateTagTemplateField(parent, tagTemplateFieldId, tagTemplateField);
CreateTagTemplateFieldAsync(CreateTagTemplateFieldRequest, CallSettings)
public virtual 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. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
CreateTagTemplateFieldRequest request = new CreateTagTemplateFieldRequest
{
ParentAsTagTemplateName = TagTemplateName.FromProjectLocationTagTemplate("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]"),
TagTemplateFieldId = "",
TagTemplateField = new TagTemplateField(),
};
// Make the request
TagTemplateField response = await dataCatalogClient.CreateTagTemplateFieldAsync(request);
CreateTagTemplateFieldAsync(CreateTagTemplateFieldRequest, CancellationToken)
public virtual Task<TagTemplateField> CreateTagTemplateFieldAsync(CreateTagTemplateFieldRequest request, CancellationToken cancellationToken)
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. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskTagTemplateField | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
CreateTagTemplateFieldRequest request = new CreateTagTemplateFieldRequest
{
ParentAsTagTemplateName = TagTemplateName.FromProjectLocationTagTemplate("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]"),
TagTemplateFieldId = "",
TagTemplateField = new TagTemplateField(),
};
// Make the request
TagTemplateField response = await dataCatalogClient.CreateTagTemplateFieldAsync(request);
CreateTagTemplateFieldAsync(TagTemplateName, string, TagTemplateField, CallSettings)
public virtual Task<TagTemplateField> CreateTagTemplateFieldAsync(TagTemplateName parent, string tagTemplateFieldId, TagTemplateField tagTemplateField, 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 |
parent | TagTemplateName Required. The name of the project and the template location region. |
tagTemplateFieldId | string Required. The ID of the tag template field to create. Note: Adding a required field to an existing template is not allowed. Field IDs can contain letters (both uppercase and lowercase), numbers (0-9), underscores (_) and dashes (-). Field IDs must be at least 1 character long and at most 128 characters long. Field IDs must also be unique within their template. |
tagTemplateField | TagTemplateField Required. The tag template field to create. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskTagTemplateField | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
TagTemplateName parent = TagTemplateName.FromProjectLocationTagTemplate("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]");
string tagTemplateFieldId = "";
TagTemplateField tagTemplateField = new TagTemplateField();
// Make the request
TagTemplateField response = await dataCatalogClient.CreateTagTemplateFieldAsync(parent, tagTemplateFieldId, tagTemplateField);
CreateTagTemplateFieldAsync(TagTemplateName, string, TagTemplateField, CancellationToken)
public virtual Task<TagTemplateField> CreateTagTemplateFieldAsync(TagTemplateName parent, string tagTemplateFieldId, TagTemplateField tagTemplateField, CancellationToken cancellationToken)
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 |
parent | TagTemplateName Required. The name of the project and the template location region. |
tagTemplateFieldId | string Required. The ID of the tag template field to create. Note: Adding a required field to an existing template is not allowed. Field IDs can contain letters (both uppercase and lowercase), numbers (0-9), underscores (_) and dashes (-). Field IDs must be at least 1 character long and at most 128 characters long. Field IDs must also be unique within their template. |
tagTemplateField | TagTemplateField Required. The tag template field to create. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskTagTemplateField | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
TagTemplateName parent = TagTemplateName.FromProjectLocationTagTemplate("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]");
string tagTemplateFieldId = "";
TagTemplateField tagTemplateField = new TagTemplateField();
// Make the request
TagTemplateField response = await dataCatalogClient.CreateTagTemplateFieldAsync(parent, tagTemplateFieldId, tagTemplateField);
CreateTagTemplateFieldAsync(string, string, TagTemplateField, CallSettings)
public virtual Task<TagTemplateField> CreateTagTemplateFieldAsync(string parent, string tagTemplateFieldId, TagTemplateField tagTemplateField, 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 |
parent | string Required. The name of the project and the template location region. |
tagTemplateFieldId | string Required. The ID of the tag template field to create. Note: Adding a required field to an existing template is not allowed. Field IDs can contain letters (both uppercase and lowercase), numbers (0-9), underscores (_) and dashes (-). Field IDs must be at least 1 character long and at most 128 characters long. Field IDs must also be unique within their template. |
tagTemplateField | TagTemplateField Required. The tag template field to create. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskTagTemplateField | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/tagTemplates/[TAG_TEMPLATE]";
string tagTemplateFieldId = "";
TagTemplateField tagTemplateField = new TagTemplateField();
// Make the request
TagTemplateField response = await dataCatalogClient.CreateTagTemplateFieldAsync(parent, tagTemplateFieldId, tagTemplateField);
CreateTagTemplateFieldAsync(string, string, TagTemplateField, CancellationToken)
public virtual Task<TagTemplateField> CreateTagTemplateFieldAsync(string parent, string tagTemplateFieldId, TagTemplateField tagTemplateField, CancellationToken cancellationToken)
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 |
parent | string Required. The name of the project and the template location region. |
tagTemplateFieldId | string Required. The ID of the tag template field to create. Note: Adding a required field to an existing template is not allowed. Field IDs can contain letters (both uppercase and lowercase), numbers (0-9), underscores (_) and dashes (-). Field IDs must be at least 1 character long and at most 128 characters long. Field IDs must also be unique within their template. |
tagTemplateField | TagTemplateField Required. The tag template field to create. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskTagTemplateField | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/tagTemplates/[TAG_TEMPLATE]";
string tagTemplateFieldId = "";
TagTemplateField tagTemplateField = new TagTemplateField();
// Make the request
TagTemplateField response = await dataCatalogClient.CreateTagTemplateFieldAsync(parent, tagTemplateFieldId, tagTemplateField);
DeleteEntry(DeleteEntryRequest, CallSettings)
public virtual 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. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
DeleteEntryRequest request = new DeleteEntryRequest
{
EntryName = EntryName.FromProjectLocationEntryGroupEntry("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]"),
};
// Make the request
dataCatalogClient.DeleteEntry(request);
DeleteEntry(EntryName, CallSettings)
public virtual void DeleteEntry(EntryName name, 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 |
name | EntryName Required. The name of the entry to delete. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
EntryName name = EntryName.FromProjectLocationEntryGroupEntry("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
// Make the request
dataCatalogClient.DeleteEntry(name);
DeleteEntry(string, CallSettings)
public virtual void DeleteEntry(string name, 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 |
name | string Required. The name of the entry to delete. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/entryGroups/[ENTRY_GROUP]/entries/[ENTRY]";
// Make the request
dataCatalogClient.DeleteEntry(name);
DeleteEntryAsync(DeleteEntryRequest, CallSettings)
public virtual 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. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
DeleteEntryRequest request = new DeleteEntryRequest
{
EntryName = EntryName.FromProjectLocationEntryGroupEntry("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]"),
};
// Make the request
await dataCatalogClient.DeleteEntryAsync(request);
DeleteEntryAsync(DeleteEntryRequest, CancellationToken)
public virtual Task DeleteEntryAsync(DeleteEntryRequest request, CancellationToken cancellationToken)
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. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
DeleteEntryRequest request = new DeleteEntryRequest
{
EntryName = EntryName.FromProjectLocationEntryGroupEntry("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]"),
};
// Make the request
await dataCatalogClient.DeleteEntryAsync(request);
DeleteEntryAsync(EntryName, CallSettings)
public virtual Task DeleteEntryAsync(EntryName name, 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 |
name | EntryName Required. The name of the entry to delete. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
EntryName name = EntryName.FromProjectLocationEntryGroupEntry("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
// Make the request
await dataCatalogClient.DeleteEntryAsync(name);
DeleteEntryAsync(EntryName, CancellationToken)
public virtual Task DeleteEntryAsync(EntryName name, CancellationToken cancellationToken)
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 |
name | EntryName Required. The name of the entry to delete. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
EntryName name = EntryName.FromProjectLocationEntryGroupEntry("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
// Make the request
await dataCatalogClient.DeleteEntryAsync(name);
DeleteEntryAsync(string, CallSettings)
public virtual Task DeleteEntryAsync(string name, 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 |
name | string Required. The name of the entry to delete. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/entryGroups/[ENTRY_GROUP]/entries/[ENTRY]";
// Make the request
await dataCatalogClient.DeleteEntryAsync(name);
DeleteEntryAsync(string, CancellationToken)
public virtual Task DeleteEntryAsync(string name, CancellationToken cancellationToken)
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 |
name | string Required. The name of the entry to delete. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/entryGroups/[ENTRY_GROUP]/entries/[ENTRY]";
// Make the request
await dataCatalogClient.DeleteEntryAsync(name);
DeleteEntryGroup(DeleteEntryGroupRequest, CallSettings)
public virtual 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. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
DeleteEntryGroupRequest request = new DeleteEntryGroupRequest
{
EntryGroupName = EntryGroupName.FromProjectLocationEntryGroup("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]"),
Force = false,
};
// Make the request
dataCatalogClient.DeleteEntryGroup(request);
DeleteEntryGroup(EntryGroupName, CallSettings)
public virtual void DeleteEntryGroup(EntryGroupName name, 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 |
name | EntryGroupName Required. The name of the entry group to delete. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
EntryGroupName name = EntryGroupName.FromProjectLocationEntryGroup("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]");
// Make the request
dataCatalogClient.DeleteEntryGroup(name);
DeleteEntryGroup(string, CallSettings)
public virtual void DeleteEntryGroup(string name, 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 |
name | string Required. The name of the entry group to delete. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/entryGroups/[ENTRY_GROUP]";
// Make the request
dataCatalogClient.DeleteEntryGroup(name);
DeleteEntryGroupAsync(DeleteEntryGroupRequest, CallSettings)
public virtual 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. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
DeleteEntryGroupRequest request = new DeleteEntryGroupRequest
{
EntryGroupName = EntryGroupName.FromProjectLocationEntryGroup("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]"),
Force = false,
};
// Make the request
await dataCatalogClient.DeleteEntryGroupAsync(request);
DeleteEntryGroupAsync(DeleteEntryGroupRequest, CancellationToken)
public virtual Task DeleteEntryGroupAsync(DeleteEntryGroupRequest request, CancellationToken cancellationToken)
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. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
DeleteEntryGroupRequest request = new DeleteEntryGroupRequest
{
EntryGroupName = EntryGroupName.FromProjectLocationEntryGroup("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]"),
Force = false,
};
// Make the request
await dataCatalogClient.DeleteEntryGroupAsync(request);
DeleteEntryGroupAsync(EntryGroupName, CallSettings)
public virtual Task DeleteEntryGroupAsync(EntryGroupName name, 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 |
name | EntryGroupName Required. The name of the entry group to delete. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
EntryGroupName name = EntryGroupName.FromProjectLocationEntryGroup("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]");
// Make the request
await dataCatalogClient.DeleteEntryGroupAsync(name);
DeleteEntryGroupAsync(EntryGroupName, CancellationToken)
public virtual Task DeleteEntryGroupAsync(EntryGroupName name, CancellationToken cancellationToken)
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 |
name | EntryGroupName Required. The name of the entry group to delete. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
EntryGroupName name = EntryGroupName.FromProjectLocationEntryGroup("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]");
// Make the request
await dataCatalogClient.DeleteEntryGroupAsync(name);
DeleteEntryGroupAsync(string, CallSettings)
public virtual Task DeleteEntryGroupAsync(string name, 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 |
name | string Required. The name of the entry group to delete. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/entryGroups/[ENTRY_GROUP]";
// Make the request
await dataCatalogClient.DeleteEntryGroupAsync(name);
DeleteEntryGroupAsync(string, CancellationToken)
public virtual Task DeleteEntryGroupAsync(string name, CancellationToken cancellationToken)
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 |
name | string Required. The name of the entry group to delete. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/entryGroups/[ENTRY_GROUP]";
// Make the request
await dataCatalogClient.DeleteEntryGroupAsync(name);
DeleteTag(DeleteTagRequest, CallSettings)
public virtual 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. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
DeleteTagRequest request = new DeleteTagRequest
{
EntryName = EntryName.FromProjectLocationEntryGroupEntry("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]"),
};
// Make the request
dataCatalogClient.DeleteTag(request);
DeleteTag(EntryName, CallSettings)
public virtual void DeleteTag(EntryName name, CallSettings callSettings = null)
Deletes a tag.
Parameters | |
---|---|
Name | Description |
name | EntryName Required. The name of the tag to delete. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
EntryName name = EntryName.FromProjectLocationEntryGroupEntry("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
// Make the request
dataCatalogClient.DeleteTag(name);
DeleteTag(string, CallSettings)
public virtual void DeleteTag(string name, CallSettings callSettings = null)
Deletes a tag.
Parameters | |
---|---|
Name | Description |
name | string Required. The name of the tag to delete. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/entryGroups/[ENTRY_GROUP]/entries/[ENTRY]";
// Make the request
dataCatalogClient.DeleteTag(name);
DeleteTagAsync(DeleteTagRequest, CallSettings)
public virtual 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. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
DeleteTagRequest request = new DeleteTagRequest
{
EntryName = EntryName.FromProjectLocationEntryGroupEntry("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]"),
};
// Make the request
await dataCatalogClient.DeleteTagAsync(request);
DeleteTagAsync(DeleteTagRequest, CancellationToken)
public virtual Task DeleteTagAsync(DeleteTagRequest request, CancellationToken cancellationToken)
Deletes a tag.
Parameters | |
---|---|
Name | Description |
request | DeleteTagRequest The request object containing all of the parameters for the API call. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
DeleteTagRequest request = new DeleteTagRequest
{
EntryName = EntryName.FromProjectLocationEntryGroupEntry("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]"),
};
// Make the request
await dataCatalogClient.DeleteTagAsync(request);
DeleteTagAsync(EntryName, CallSettings)
public virtual Task DeleteTagAsync(EntryName name, CallSettings callSettings = null)
Deletes a tag.
Parameters | |
---|---|
Name | Description |
name | EntryName Required. The name of the tag to delete. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
EntryName name = EntryName.FromProjectLocationEntryGroupEntry("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
// Make the request
await dataCatalogClient.DeleteTagAsync(name);
DeleteTagAsync(EntryName, CancellationToken)
public virtual Task DeleteTagAsync(EntryName name, CancellationToken cancellationToken)
Deletes a tag.
Parameters | |
---|---|
Name | Description |
name | EntryName Required. The name of the tag to delete. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
EntryName name = EntryName.FromProjectLocationEntryGroupEntry("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
// Make the request
await dataCatalogClient.DeleteTagAsync(name);
DeleteTagAsync(string, CallSettings)
public virtual Task DeleteTagAsync(string name, CallSettings callSettings = null)
Deletes a tag.
Parameters | |
---|---|
Name | Description |
name | string Required. The name of the tag to delete. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/entryGroups/[ENTRY_GROUP]/entries/[ENTRY]";
// Make the request
await dataCatalogClient.DeleteTagAsync(name);
DeleteTagAsync(string, CancellationToken)
public virtual Task DeleteTagAsync(string name, CancellationToken cancellationToken)
Deletes a tag.
Parameters | |
---|---|
Name | Description |
name | string Required. The name of the tag to delete. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/entryGroups/[ENTRY_GROUP]/entries/[ENTRY]";
// Make the request
await dataCatalogClient.DeleteTagAsync(name);
DeleteTagTemplate(DeleteTagTemplateRequest, CallSettings)
public virtual 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. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
DeleteTagTemplateRequest request = new DeleteTagTemplateRequest
{
TagTemplateName = TagTemplateName.FromProjectLocationTagTemplate("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]"),
Force = false,
};
// Make the request
dataCatalogClient.DeleteTagTemplate(request);
DeleteTagTemplate(TagTemplateName, bool, CallSettings)
public virtual void DeleteTagTemplate(TagTemplateName name, bool force, 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 |
name | TagTemplateName Required. The name of the tag template to delete. |
force | bool Required. If true, deletes all tags that use this template. Currently, |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
TagTemplateName name = TagTemplateName.FromProjectLocationTagTemplate("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]");
bool force = false;
// Make the request
dataCatalogClient.DeleteTagTemplate(name, force);
DeleteTagTemplate(string, bool, CallSettings)
public virtual void DeleteTagTemplate(string name, bool force, 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 |
name | string Required. The name of the tag template to delete. |
force | bool Required. If true, deletes all tags that use this template. Currently, |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/tagTemplates/[TAG_TEMPLATE]";
bool force = false;
// Make the request
dataCatalogClient.DeleteTagTemplate(name, force);
DeleteTagTemplateAsync(DeleteTagTemplateRequest, CallSettings)
public virtual 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. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
DeleteTagTemplateRequest request = new DeleteTagTemplateRequest
{
TagTemplateName = TagTemplateName.FromProjectLocationTagTemplate("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]"),
Force = false,
};
// Make the request
await dataCatalogClient.DeleteTagTemplateAsync(request);
DeleteTagTemplateAsync(DeleteTagTemplateRequest, CancellationToken)
public virtual Task DeleteTagTemplateAsync(DeleteTagTemplateRequest request, CancellationToken cancellationToken)
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. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
DeleteTagTemplateRequest request = new DeleteTagTemplateRequest
{
TagTemplateName = TagTemplateName.FromProjectLocationTagTemplate("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]"),
Force = false,
};
// Make the request
await dataCatalogClient.DeleteTagTemplateAsync(request);
DeleteTagTemplateAsync(TagTemplateName, bool, CallSettings)
public virtual Task DeleteTagTemplateAsync(TagTemplateName name, bool force, 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 |
name | TagTemplateName Required. The name of the tag template to delete. |
force | bool Required. If true, deletes all tags that use this template. Currently, |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
TagTemplateName name = TagTemplateName.FromProjectLocationTagTemplate("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]");
bool force = false;
// Make the request
await dataCatalogClient.DeleteTagTemplateAsync(name, force);
DeleteTagTemplateAsync(TagTemplateName, bool, CancellationToken)
public virtual Task DeleteTagTemplateAsync(TagTemplateName name, bool force, CancellationToken cancellationToken)
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 |
name | TagTemplateName Required. The name of the tag template to delete. |
force | bool Required. If true, deletes all tags that use this template. Currently, |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
TagTemplateName name = TagTemplateName.FromProjectLocationTagTemplate("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]");
bool force = false;
// Make the request
await dataCatalogClient.DeleteTagTemplateAsync(name, force);
DeleteTagTemplateAsync(string, bool, CallSettings)
public virtual Task DeleteTagTemplateAsync(string name, bool force, 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 |
name | string Required. The name of the tag template to delete. |
force | bool Required. If true, deletes all tags that use this template. Currently, |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/tagTemplates/[TAG_TEMPLATE]";
bool force = false;
// Make the request
await dataCatalogClient.DeleteTagTemplateAsync(name, force);
DeleteTagTemplateAsync(string, bool, CancellationToken)
public virtual Task DeleteTagTemplateAsync(string name, bool force, CancellationToken cancellationToken)
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 |
name | string Required. The name of the tag template to delete. |
force | bool Required. If true, deletes all tags that use this template. Currently, |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/tagTemplates/[TAG_TEMPLATE]";
bool force = false;
// Make the request
await dataCatalogClient.DeleteTagTemplateAsync(name, force);
DeleteTagTemplateField(DeleteTagTemplateFieldRequest, CallSettings)
public virtual 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. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
DeleteTagTemplateFieldRequest request = new DeleteTagTemplateFieldRequest
{
TagTemplateFieldName = TagTemplateFieldName.FromProjectLocationTagTemplateField("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]"),
Force = false,
};
// Make the request
dataCatalogClient.DeleteTagTemplateField(request);
DeleteTagTemplateField(TagTemplateFieldName, bool, CallSettings)
public virtual void DeleteTagTemplateField(TagTemplateFieldName name, bool force, 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 |
name | TagTemplateFieldName Required. The name of the tag template field to delete. |
force | bool Required. If true, deletes this field from any tags that use it. Currently, |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
TagTemplateFieldName name = TagTemplateFieldName.FromProjectLocationTagTemplateField("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]");
bool force = false;
// Make the request
dataCatalogClient.DeleteTagTemplateField(name, force);
DeleteTagTemplateField(string, bool, CallSettings)
public virtual void DeleteTagTemplateField(string name, bool force, 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 |
name | string Required. The name of the tag template field to delete. |
force | bool Required. If true, deletes this field from any tags that use it. Currently, |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/tagTemplates/[TAG_TEMPLATE]/fields/[FIELD]";
bool force = false;
// Make the request
dataCatalogClient.DeleteTagTemplateField(name, force);
DeleteTagTemplateFieldAsync(DeleteTagTemplateFieldRequest, CallSettings)
public virtual 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. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
DeleteTagTemplateFieldRequest request = new DeleteTagTemplateFieldRequest
{
TagTemplateFieldName = TagTemplateFieldName.FromProjectLocationTagTemplateField("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]"),
Force = false,
};
// Make the request
await dataCatalogClient.DeleteTagTemplateFieldAsync(request);
DeleteTagTemplateFieldAsync(DeleteTagTemplateFieldRequest, CancellationToken)
public virtual Task DeleteTagTemplateFieldAsync(DeleteTagTemplateFieldRequest request, CancellationToken cancellationToken)
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. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
DeleteTagTemplateFieldRequest request = new DeleteTagTemplateFieldRequest
{
TagTemplateFieldName = TagTemplateFieldName.FromProjectLocationTagTemplateField("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]"),
Force = false,
};
// Make the request
await dataCatalogClient.DeleteTagTemplateFieldAsync(request);
DeleteTagTemplateFieldAsync(TagTemplateFieldName, bool, CallSettings)
public virtual Task DeleteTagTemplateFieldAsync(TagTemplateFieldName name, bool force, 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 |
name | TagTemplateFieldName Required. The name of the tag template field to delete. |
force | bool Required. If true, deletes this field from any tags that use it. Currently, |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
TagTemplateFieldName name = TagTemplateFieldName.FromProjectLocationTagTemplateField("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]");
bool force = false;
// Make the request
await dataCatalogClient.DeleteTagTemplateFieldAsync(name, force);
DeleteTagTemplateFieldAsync(TagTemplateFieldName, bool, CancellationToken)
public virtual Task DeleteTagTemplateFieldAsync(TagTemplateFieldName name, bool force, CancellationToken cancellationToken)
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 |
name | TagTemplateFieldName Required. The name of the tag template field to delete. |
force | bool Required. If true, deletes this field from any tags that use it. Currently, |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
TagTemplateFieldName name = TagTemplateFieldName.FromProjectLocationTagTemplateField("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]");
bool force = false;
// Make the request
await dataCatalogClient.DeleteTagTemplateFieldAsync(name, force);
DeleteTagTemplateFieldAsync(string, bool, CallSettings)
public virtual Task DeleteTagTemplateFieldAsync(string name, bool force, 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 |
name | string Required. The name of the tag template field to delete. |
force | bool Required. If true, deletes this field from any tags that use it. Currently, |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/tagTemplates/[TAG_TEMPLATE]/fields/[FIELD]";
bool force = false;
// Make the request
await dataCatalogClient.DeleteTagTemplateFieldAsync(name, force);
DeleteTagTemplateFieldAsync(string, bool, CancellationToken)
public virtual Task DeleteTagTemplateFieldAsync(string name, bool force, CancellationToken cancellationToken)
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 |
name | string Required. The name of the tag template field to delete. |
force | bool Required. If true, deletes this field from any tags that use it. Currently, |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/tagTemplates/[TAG_TEMPLATE]/fields/[FIELD]";
bool force = false;
// Make the request
await dataCatalogClient.DeleteTagTemplateFieldAsync(name, force);
GetEntry(EntryName, CallSettings)
public virtual Entry GetEntry(EntryName name, CallSettings callSettings = null)
Gets an entry.
Parameters | |
---|---|
Name | Description |
name | EntryName Required. The name of the entry to get. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Entry | The RPC response. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
EntryName name = EntryName.FromProjectLocationEntryGroupEntry("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
// Make the request
Entry response = dataCatalogClient.GetEntry(name);
GetEntry(GetEntryRequest, CallSettings)
public virtual 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. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
GetEntryRequest request = new GetEntryRequest
{
EntryName = EntryName.FromProjectLocationEntryGroupEntry("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]"),
};
// Make the request
Entry response = dataCatalogClient.GetEntry(request);
GetEntry(string, CallSettings)
public virtual Entry GetEntry(string name, CallSettings callSettings = null)
Gets an entry.
Parameters | |
---|---|
Name | Description |
name | string Required. The name of the entry to get. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Entry | The RPC response. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/entryGroups/[ENTRY_GROUP]/entries/[ENTRY]";
// Make the request
Entry response = dataCatalogClient.GetEntry(name);
GetEntryAsync(EntryName, CallSettings)
public virtual Task<Entry> GetEntryAsync(EntryName name, CallSettings callSettings = null)
Gets an entry.
Parameters | |
---|---|
Name | Description |
name | EntryName Required. The name of the entry to get. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskEntry | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
EntryName name = EntryName.FromProjectLocationEntryGroupEntry("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
// Make the request
Entry response = await dataCatalogClient.GetEntryAsync(name);
GetEntryAsync(EntryName, CancellationToken)
public virtual Task<Entry> GetEntryAsync(EntryName name, CancellationToken cancellationToken)
Gets an entry.
Parameters | |
---|---|
Name | Description |
name | EntryName Required. The name of the entry to get. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskEntry | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
EntryName name = EntryName.FromProjectLocationEntryGroupEntry("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
// Make the request
Entry response = await dataCatalogClient.GetEntryAsync(name);
GetEntryAsync(GetEntryRequest, CallSettings)
public virtual 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. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
GetEntryRequest request = new GetEntryRequest
{
EntryName = EntryName.FromProjectLocationEntryGroupEntry("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]"),
};
// Make the request
Entry response = await dataCatalogClient.GetEntryAsync(request);
GetEntryAsync(GetEntryRequest, CancellationToken)
public virtual Task<Entry> GetEntryAsync(GetEntryRequest request, CancellationToken cancellationToken)
Gets an entry.
Parameters | |
---|---|
Name | Description |
request | GetEntryRequest The request object containing all of the parameters for the API call. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskEntry | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
GetEntryRequest request = new GetEntryRequest
{
EntryName = EntryName.FromProjectLocationEntryGroupEntry("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]"),
};
// Make the request
Entry response = await dataCatalogClient.GetEntryAsync(request);
GetEntryAsync(string, CallSettings)
public virtual Task<Entry> GetEntryAsync(string name, CallSettings callSettings = null)
Gets an entry.
Parameters | |
---|---|
Name | Description |
name | string Required. The name of the entry to get. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskEntry | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/entryGroups/[ENTRY_GROUP]/entries/[ENTRY]";
// Make the request
Entry response = await dataCatalogClient.GetEntryAsync(name);
GetEntryAsync(string, CancellationToken)
public virtual Task<Entry> GetEntryAsync(string name, CancellationToken cancellationToken)
Gets an entry.
Parameters | |
---|---|
Name | Description |
name | string Required. The name of the entry to get. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskEntry | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/entryGroups/[ENTRY_GROUP]/entries/[ENTRY]";
// Make the request
Entry response = await dataCatalogClient.GetEntryAsync(name);
GetEntryGroup(EntryGroupName, CallSettings)
public virtual EntryGroup GetEntryGroup(EntryGroupName name, CallSettings callSettings = null)
Gets an entry group.
Parameters | |
---|---|
Name | Description |
name | EntryGroupName Required. The name of the entry group to get. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
EntryGroup | The RPC response. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
EntryGroupName name = EntryGroupName.FromProjectLocationEntryGroup("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]");
// Make the request
EntryGroup response = dataCatalogClient.GetEntryGroup(name);
GetEntryGroup(EntryGroupName, FieldMask, CallSettings)
public virtual EntryGroup GetEntryGroup(EntryGroupName name, FieldMask readMask, CallSettings callSettings = null)
Gets an entry group.
Parameters | |
---|---|
Name | Description |
name | EntryGroupName Required. The name of the entry group to get. |
readMask | FieldMask The fields to return. If empty or omitted, all fields are returned. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
EntryGroup | The RPC response. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
EntryGroupName name = EntryGroupName.FromProjectLocationEntryGroup("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]");
FieldMask readMask = new FieldMask();
// Make the request
EntryGroup response = dataCatalogClient.GetEntryGroup(name, readMask);
GetEntryGroup(GetEntryGroupRequest, CallSettings)
public virtual 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. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
GetEntryGroupRequest request = new GetEntryGroupRequest
{
EntryGroupName = EntryGroupName.FromProjectLocationEntryGroup("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]"),
ReadMask = new FieldMask(),
};
// Make the request
EntryGroup response = dataCatalogClient.GetEntryGroup(request);
GetEntryGroup(string, CallSettings)
public virtual EntryGroup GetEntryGroup(string name, CallSettings callSettings = null)
Gets an entry group.
Parameters | |
---|---|
Name | Description |
name | string Required. The name of the entry group to get. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
EntryGroup | The RPC response. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/entryGroups/[ENTRY_GROUP]";
// Make the request
EntryGroup response = dataCatalogClient.GetEntryGroup(name);
GetEntryGroup(string, FieldMask, CallSettings)
public virtual EntryGroup GetEntryGroup(string name, FieldMask readMask, CallSettings callSettings = null)
Gets an entry group.
Parameters | |
---|---|
Name | Description |
name | string Required. The name of the entry group to get. |
readMask | FieldMask The fields to return. If empty or omitted, all fields are returned. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
EntryGroup | The RPC response. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/entryGroups/[ENTRY_GROUP]";
FieldMask readMask = new FieldMask();
// Make the request
EntryGroup response = dataCatalogClient.GetEntryGroup(name, readMask);
GetEntryGroupAsync(EntryGroupName, CallSettings)
public virtual Task<EntryGroup> GetEntryGroupAsync(EntryGroupName name, CallSettings callSettings = null)
Gets an entry group.
Parameters | |
---|---|
Name | Description |
name | EntryGroupName Required. The name of the entry group to get. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskEntryGroup | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
EntryGroupName name = EntryGroupName.FromProjectLocationEntryGroup("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]");
// Make the request
EntryGroup response = await dataCatalogClient.GetEntryGroupAsync(name);
GetEntryGroupAsync(EntryGroupName, FieldMask, CallSettings)
public virtual Task<EntryGroup> GetEntryGroupAsync(EntryGroupName name, FieldMask readMask, CallSettings callSettings = null)
Gets an entry group.
Parameters | |
---|---|
Name | Description |
name | EntryGroupName Required. The name of the entry group to get. |
readMask | FieldMask The fields to return. If empty or omitted, all fields are returned. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskEntryGroup | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
EntryGroupName name = EntryGroupName.FromProjectLocationEntryGroup("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]");
FieldMask readMask = new FieldMask();
// Make the request
EntryGroup response = await dataCatalogClient.GetEntryGroupAsync(name, readMask);
GetEntryGroupAsync(EntryGroupName, FieldMask, CancellationToken)
public virtual Task<EntryGroup> GetEntryGroupAsync(EntryGroupName name, FieldMask readMask, CancellationToken cancellationToken)
Gets an entry group.
Parameters | |
---|---|
Name | Description |
name | EntryGroupName Required. The name of the entry group to get. |
readMask | FieldMask The fields to return. If empty or omitted, all fields are returned. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskEntryGroup | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
EntryGroupName name = EntryGroupName.FromProjectLocationEntryGroup("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]");
FieldMask readMask = new FieldMask();
// Make the request
EntryGroup response = await dataCatalogClient.GetEntryGroupAsync(name, readMask);
GetEntryGroupAsync(EntryGroupName, CancellationToken)
public virtual Task<EntryGroup> GetEntryGroupAsync(EntryGroupName name, CancellationToken cancellationToken)
Gets an entry group.
Parameters | |
---|---|
Name | Description |
name | EntryGroupName Required. The name of the entry group to get. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskEntryGroup | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
EntryGroupName name = EntryGroupName.FromProjectLocationEntryGroup("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]");
// Make the request
EntryGroup response = await dataCatalogClient.GetEntryGroupAsync(name);
GetEntryGroupAsync(GetEntryGroupRequest, CallSettings)
public virtual 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. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
GetEntryGroupRequest request = new GetEntryGroupRequest
{
EntryGroupName = EntryGroupName.FromProjectLocationEntryGroup("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]"),
ReadMask = new FieldMask(),
};
// Make the request
EntryGroup response = await dataCatalogClient.GetEntryGroupAsync(request);
GetEntryGroupAsync(GetEntryGroupRequest, CancellationToken)
public virtual Task<EntryGroup> GetEntryGroupAsync(GetEntryGroupRequest request, CancellationToken cancellationToken)
Gets an entry group.
Parameters | |
---|---|
Name | Description |
request | GetEntryGroupRequest The request object containing all of the parameters for the API call. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskEntryGroup | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
GetEntryGroupRequest request = new GetEntryGroupRequest
{
EntryGroupName = EntryGroupName.FromProjectLocationEntryGroup("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]"),
ReadMask = new FieldMask(),
};
// Make the request
EntryGroup response = await dataCatalogClient.GetEntryGroupAsync(request);
GetEntryGroupAsync(string, CallSettings)
public virtual Task<EntryGroup> GetEntryGroupAsync(string name, CallSettings callSettings = null)
Gets an entry group.
Parameters | |
---|---|
Name | Description |
name | string Required. The name of the entry group to get. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskEntryGroup | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/entryGroups/[ENTRY_GROUP]";
// Make the request
EntryGroup response = await dataCatalogClient.GetEntryGroupAsync(name);
GetEntryGroupAsync(string, FieldMask, CallSettings)
public virtual Task<EntryGroup> GetEntryGroupAsync(string name, FieldMask readMask, CallSettings callSettings = null)
Gets an entry group.
Parameters | |
---|---|
Name | Description |
name | string Required. The name of the entry group to get. |
readMask | FieldMask The fields to return. If empty or omitted, all fields are returned. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskEntryGroup | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/entryGroups/[ENTRY_GROUP]";
FieldMask readMask = new FieldMask();
// Make the request
EntryGroup response = await dataCatalogClient.GetEntryGroupAsync(name, readMask);
GetEntryGroupAsync(string, FieldMask, CancellationToken)
public virtual Task<EntryGroup> GetEntryGroupAsync(string name, FieldMask readMask, CancellationToken cancellationToken)
Gets an entry group.
Parameters | |
---|---|
Name | Description |
name | string Required. The name of the entry group to get. |
readMask | FieldMask The fields to return. If empty or omitted, all fields are returned. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskEntryGroup | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/entryGroups/[ENTRY_GROUP]";
FieldMask readMask = new FieldMask();
// Make the request
EntryGroup response = await dataCatalogClient.GetEntryGroupAsync(name, readMask);
GetEntryGroupAsync(string, CancellationToken)
public virtual Task<EntryGroup> GetEntryGroupAsync(string name, CancellationToken cancellationToken)
Gets an entry group.
Parameters | |
---|---|
Name | Description |
name | string Required. The name of the entry group to get. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskEntryGroup | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/entryGroups/[ENTRY_GROUP]";
// Make the request
EntryGroup response = await dataCatalogClient.GetEntryGroupAsync(name);
GetIamPolicy(IResourceName, CallSettings)
public virtual Policy GetIamPolicy(IResourceName resource, 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 |
resource | IResourceName REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Policy | The RPC response. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
IResourceName resource = new UnparsedResourceName("a/wildcard/resource");
// Make the request
Policy response = dataCatalogClient.GetIamPolicy(resource);
GetIamPolicy(GetIamPolicyRequest, CallSettings)
public virtual 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. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
GetIamPolicyRequest request = new GetIamPolicyRequest
{
ResourceAsResourceName = new UnparsedResourceName("a/wildcard/resource"),
Options = new GetPolicyOptions(),
};
// Make the request
Policy response = dataCatalogClient.GetIamPolicy(request);
GetIamPolicy(string, CallSettings)
public virtual Policy GetIamPolicy(string resource, 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 |
resource | string REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Policy | The RPC response. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
string resource = "a/wildcard/resource";
// Make the request
Policy response = dataCatalogClient.GetIamPolicy(resource);
GetIamPolicyAsync(IResourceName, CallSettings)
public virtual Task<Policy> GetIamPolicyAsync(IResourceName resource, 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 |
resource | IResourceName REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskPolicy | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
IResourceName resource = new UnparsedResourceName("a/wildcard/resource");
// Make the request
Policy response = await dataCatalogClient.GetIamPolicyAsync(resource);
GetIamPolicyAsync(IResourceName, CancellationToken)
public virtual Task<Policy> GetIamPolicyAsync(IResourceName resource, CancellationToken cancellationToken)
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 |
resource | IResourceName REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskPolicy | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
IResourceName resource = new UnparsedResourceName("a/wildcard/resource");
// Make the request
Policy response = await dataCatalogClient.GetIamPolicyAsync(resource);
GetIamPolicyAsync(GetIamPolicyRequest, CallSettings)
public virtual 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. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
GetIamPolicyRequest request = new GetIamPolicyRequest
{
ResourceAsResourceName = new UnparsedResourceName("a/wildcard/resource"),
Options = new GetPolicyOptions(),
};
// Make the request
Policy response = await dataCatalogClient.GetIamPolicyAsync(request);
GetIamPolicyAsync(GetIamPolicyRequest, CancellationToken)
public virtual Task<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, CancellationToken cancellationToken)
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. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskPolicy | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
GetIamPolicyRequest request = new GetIamPolicyRequest
{
ResourceAsResourceName = new UnparsedResourceName("a/wildcard/resource"),
Options = new GetPolicyOptions(),
};
// Make the request
Policy response = await dataCatalogClient.GetIamPolicyAsync(request);
GetIamPolicyAsync(string, CallSettings)
public virtual Task<Policy> GetIamPolicyAsync(string resource, 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 |
resource | string REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskPolicy | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
string resource = "a/wildcard/resource";
// Make the request
Policy response = await dataCatalogClient.GetIamPolicyAsync(resource);
GetIamPolicyAsync(string, CancellationToken)
public virtual Task<Policy> GetIamPolicyAsync(string resource, CancellationToken cancellationToken)
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 |
resource | string REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskPolicy | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
string resource = "a/wildcard/resource";
// Make the request
Policy response = await dataCatalogClient.GetIamPolicyAsync(resource);
GetTagTemplate(GetTagTemplateRequest, CallSettings)
public virtual 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. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
GetTagTemplateRequest request = new GetTagTemplateRequest
{
TagTemplateName = TagTemplateName.FromProjectLocationTagTemplate("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]"),
};
// Make the request
TagTemplate response = dataCatalogClient.GetTagTemplate(request);
GetTagTemplate(TagTemplateName, CallSettings)
public virtual TagTemplate GetTagTemplate(TagTemplateName name, CallSettings callSettings = null)
Gets a tag template.
Parameters | |
---|---|
Name | Description |
name | TagTemplateName Required. The name of the tag template to get. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TagTemplate | The RPC response. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
TagTemplateName name = TagTemplateName.FromProjectLocationTagTemplate("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]");
// Make the request
TagTemplate response = dataCatalogClient.GetTagTemplate(name);
GetTagTemplate(string, CallSettings)
public virtual TagTemplate GetTagTemplate(string name, CallSettings callSettings = null)
Gets a tag template.
Parameters | |
---|---|
Name | Description |
name | string Required. The name of the tag template to get. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TagTemplate | The RPC response. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/tagTemplates/[TAG_TEMPLATE]";
// Make the request
TagTemplate response = dataCatalogClient.GetTagTemplate(name);
GetTagTemplateAsync(GetTagTemplateRequest, CallSettings)
public virtual 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. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
GetTagTemplateRequest request = new GetTagTemplateRequest
{
TagTemplateName = TagTemplateName.FromProjectLocationTagTemplate("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]"),
};
// Make the request
TagTemplate response = await dataCatalogClient.GetTagTemplateAsync(request);
GetTagTemplateAsync(GetTagTemplateRequest, CancellationToken)
public virtual Task<TagTemplate> GetTagTemplateAsync(GetTagTemplateRequest request, CancellationToken cancellationToken)
Gets a tag template.
Parameters | |
---|---|
Name | Description |
request | GetTagTemplateRequest The request object containing all of the parameters for the API call. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskTagTemplate | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
GetTagTemplateRequest request = new GetTagTemplateRequest
{
TagTemplateName = TagTemplateName.FromProjectLocationTagTemplate("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]"),
};
// Make the request
TagTemplate response = await dataCatalogClient.GetTagTemplateAsync(request);
GetTagTemplateAsync(TagTemplateName, CallSettings)
public virtual Task<TagTemplate> GetTagTemplateAsync(TagTemplateName name, CallSettings callSettings = null)
Gets a tag template.
Parameters | |
---|---|
Name | Description |
name | TagTemplateName Required. The name of the tag template to get. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskTagTemplate | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
TagTemplateName name = TagTemplateName.FromProjectLocationTagTemplate("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]");
// Make the request
TagTemplate response = await dataCatalogClient.GetTagTemplateAsync(name);
GetTagTemplateAsync(TagTemplateName, CancellationToken)
public virtual Task<TagTemplate> GetTagTemplateAsync(TagTemplateName name, CancellationToken cancellationToken)
Gets a tag template.
Parameters | |
---|---|
Name | Description |
name | TagTemplateName Required. The name of the tag template to get. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskTagTemplate | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
TagTemplateName name = TagTemplateName.FromProjectLocationTagTemplate("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]");
// Make the request
TagTemplate response = await dataCatalogClient.GetTagTemplateAsync(name);
GetTagTemplateAsync(string, CallSettings)
public virtual Task<TagTemplate> GetTagTemplateAsync(string name, CallSettings callSettings = null)
Gets a tag template.
Parameters | |
---|---|
Name | Description |
name | string Required. The name of the tag template to get. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskTagTemplate | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/tagTemplates/[TAG_TEMPLATE]";
// Make the request
TagTemplate response = await dataCatalogClient.GetTagTemplateAsync(name);
GetTagTemplateAsync(string, CancellationToken)
public virtual Task<TagTemplate> GetTagTemplateAsync(string name, CancellationToken cancellationToken)
Gets a tag template.
Parameters | |
---|---|
Name | Description |
name | string Required. The name of the tag template to get. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskTagTemplate | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/tagTemplates/[TAG_TEMPLATE]";
// Make the request
TagTemplate response = await dataCatalogClient.GetTagTemplateAsync(name);
ImportEntries(ImportEntriesRequest, CallSettings)
public virtual 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. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
ImportEntriesRequest request = new ImportEntriesRequest
{
ParentAsEntryGroupName = EntryGroupName.FromProjectLocationEntryGroup("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]"),
GcsBucketPath = "",
JobId = "",
};
// Make the request
Operation<ImportEntriesResponse, ImportEntriesMetadata> response = dataCatalogClient.ImportEntries(request);
// Poll until the returned long-running operation is complete
Operation<ImportEntriesResponse, ImportEntriesMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
ImportEntriesResponse result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ImportEntriesResponse, ImportEntriesMetadata> retrievedResponse = dataCatalogClient.PollOnceImportEntries(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
ImportEntriesResponse retrievedResult = retrievedResponse.Result;
}
ImportEntriesAsync(ImportEntriesRequest, CallSettings)
public virtual 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. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
ImportEntriesRequest request = new ImportEntriesRequest
{
ParentAsEntryGroupName = EntryGroupName.FromProjectLocationEntryGroup("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]"),
GcsBucketPath = "",
JobId = "",
};
// Make the request
Operation<ImportEntriesResponse, ImportEntriesMetadata> response = await dataCatalogClient.ImportEntriesAsync(request);
// Poll until the returned long-running operation is complete
Operation<ImportEntriesResponse, ImportEntriesMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
ImportEntriesResponse result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ImportEntriesResponse, ImportEntriesMetadata> retrievedResponse = await dataCatalogClient.PollOnceImportEntriesAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
ImportEntriesResponse retrievedResult = retrievedResponse.Result;
}
ImportEntriesAsync(ImportEntriesRequest, CancellationToken)
public virtual Task<Operation<ImportEntriesResponse, ImportEntriesMetadata>> ImportEntriesAsync(ImportEntriesRequest request, CancellationToken cancellationToken)
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. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskOperationImportEntriesResponseImportEntriesMetadata | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
ImportEntriesRequest request = new ImportEntriesRequest
{
ParentAsEntryGroupName = EntryGroupName.FromProjectLocationEntryGroup("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]"),
GcsBucketPath = "",
JobId = "",
};
// Make the request
Operation<ImportEntriesResponse, ImportEntriesMetadata> response = await dataCatalogClient.ImportEntriesAsync(request);
// Poll until the returned long-running operation is complete
Operation<ImportEntriesResponse, ImportEntriesMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
ImportEntriesResponse result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ImportEntriesResponse, ImportEntriesMetadata> retrievedResponse = await dataCatalogClient.PollOnceImportEntriesAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
ImportEntriesResponse retrievedResult = retrievedResponse.Result;
}
ListEntries(EntryGroupName, string, int?, CallSettings)
public virtual PagedEnumerable<ListEntriesResponse, Entry> ListEntries(EntryGroupName parent, string pageToken = null, int? pageSize = null, 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 |
parent | EntryGroupName Required. The name of the entry group that contains the entries to list. Can be provided in URL format. |
pageToken | string The token returned from the previous request. A value of |
pageSize | int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerableListEntriesResponseEntry | A pageable sequence of Entry resources. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
EntryGroupName parent = EntryGroupName.FromProjectLocationEntryGroup("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]");
// Make the request
PagedEnumerable<ListEntriesResponse, Entry> response = dataCatalogClient.ListEntries(parent);
// Iterate over all response items, lazily performing RPCs as required
foreach (Entry item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListEntriesResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Entry item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Entry> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Entry item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListEntries(ListEntriesRequest, CallSettings)
public virtual 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. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
ListEntriesRequest request = new ListEntriesRequest
{
ParentAsEntryGroupName = EntryGroupName.FromProjectLocationEntryGroup("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]"),
ReadMask = new FieldMask(),
};
// Make the request
PagedEnumerable<ListEntriesResponse, Entry> response = dataCatalogClient.ListEntries(request);
// Iterate over all response items, lazily performing RPCs as required
foreach (Entry item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListEntriesResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Entry item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Entry> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Entry item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListEntries(string, string, int?, CallSettings)
public virtual PagedEnumerable<ListEntriesResponse, Entry> ListEntries(string parent, string pageToken = null, int? pageSize = null, 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 |
parent | string Required. The name of the entry group that contains the entries to list. Can be provided in URL format. |
pageToken | string The token returned from the previous request. A value of |
pageSize | int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerableListEntriesResponseEntry | A pageable sequence of Entry resources. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/entryGroups/[ENTRY_GROUP]";
// Make the request
PagedEnumerable<ListEntriesResponse, Entry> response = dataCatalogClient.ListEntries(parent);
// Iterate over all response items, lazily performing RPCs as required
foreach (Entry item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListEntriesResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Entry item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Entry> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Entry item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListEntriesAsync(EntryGroupName, string, int?, CallSettings)
public virtual PagedAsyncEnumerable<ListEntriesResponse, Entry> ListEntriesAsync(EntryGroupName parent, string pageToken = null, int? pageSize = null, 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 |
parent | EntryGroupName Required. The name of the entry group that contains the entries to list. Can be provided in URL format. |
pageToken | string The token returned from the previous request. A value of |
pageSize | int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerableListEntriesResponseEntry | A pageable asynchronous sequence of Entry resources. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
EntryGroupName parent = EntryGroupName.FromProjectLocationEntryGroup("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]");
// Make the request
PagedAsyncEnumerable<ListEntriesResponse, Entry> response = dataCatalogClient.ListEntriesAsync(parent);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Entry item) =>
{
// Do something with each item
Console.WriteLine(item);
});
// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListEntriesResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Entry item in page)
{
// Do something with each item
Console.WriteLine(item);
}
});
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Entry> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Entry item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListEntriesAsync(ListEntriesRequest, CallSettings)
public virtual 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. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
ListEntriesRequest request = new ListEntriesRequest
{
ParentAsEntryGroupName = EntryGroupName.FromProjectLocationEntryGroup("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]"),
ReadMask = new FieldMask(),
};
// Make the request
PagedAsyncEnumerable<ListEntriesResponse, Entry> response = dataCatalogClient.ListEntriesAsync(request);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Entry item) =>
{
// Do something with each item
Console.WriteLine(item);
});
// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListEntriesResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Entry item in page)
{
// Do something with each item
Console.WriteLine(item);
}
});
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Entry> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Entry item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListEntriesAsync(string, string, int?, CallSettings)
public virtual PagedAsyncEnumerable<ListEntriesResponse, Entry> ListEntriesAsync(string parent, string pageToken = null, int? pageSize = null, 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 |
parent | string Required. The name of the entry group that contains the entries to list. Can be provided in URL format. |
pageToken | string The token returned from the previous request. A value of |
pageSize | int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerableListEntriesResponseEntry | A pageable asynchronous sequence of Entry resources. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/entryGroups/[ENTRY_GROUP]";
// Make the request
PagedAsyncEnumerable<ListEntriesResponse, Entry> response = dataCatalogClient.ListEntriesAsync(parent);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Entry item) =>
{
// Do something with each item
Console.WriteLine(item);
});
// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListEntriesResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Entry item in page)
{
// Do something with each item
Console.WriteLine(item);
}
});
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Entry> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Entry item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListEntryGroups(LocationName, string, int?, CallSettings)
public virtual PagedEnumerable<ListEntryGroupsResponse, EntryGroup> ListEntryGroups(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Lists entry groups.
Parameters | |
---|---|
Name | Description |
parent | LocationName Required. The name of the location that contains the entry groups to list. Can be provided as a URL. |
pageToken | string The token returned from the previous request. A value of |
pageSize | int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerableListEntryGroupsResponseEntryGroup | A pageable sequence of EntryGroup resources. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedEnumerable<ListEntryGroupsResponse, EntryGroup> response = dataCatalogClient.ListEntryGroups(parent);
// Iterate over all response items, lazily performing RPCs as required
foreach (EntryGroup item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListEntryGroupsResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (EntryGroup item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<EntryGroup> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (EntryGroup item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListEntryGroups(ListEntryGroupsRequest, CallSettings)
public virtual 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. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
ListEntryGroupsRequest request = new ListEntryGroupsRequest
{
ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
PagedEnumerable<ListEntryGroupsResponse, EntryGroup> response = dataCatalogClient.ListEntryGroups(request);
// Iterate over all response items, lazily performing RPCs as required
foreach (EntryGroup item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListEntryGroupsResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (EntryGroup item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<EntryGroup> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (EntryGroup item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListEntryGroups(string, string, int?, CallSettings)
public virtual PagedEnumerable<ListEntryGroupsResponse, EntryGroup> ListEntryGroups(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Lists entry groups.
Parameters | |
---|---|
Name | Description |
parent | string Required. The name of the location that contains the entry groups to list. Can be provided as a URL. |
pageToken | string The token returned from the previous request. A value of |
pageSize | int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerableListEntryGroupsResponseEntryGroup | A pageable sequence of EntryGroup resources. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedEnumerable<ListEntryGroupsResponse, EntryGroup> response = dataCatalogClient.ListEntryGroups(parent);
// Iterate over all response items, lazily performing RPCs as required
foreach (EntryGroup item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListEntryGroupsResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (EntryGroup item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<EntryGroup> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (EntryGroup item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListEntryGroupsAsync(LocationName, string, int?, CallSettings)
public virtual PagedAsyncEnumerable<ListEntryGroupsResponse, EntryGroup> ListEntryGroupsAsync(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Lists entry groups.
Parameters | |
---|---|
Name | Description |
parent | LocationName Required. The name of the location that contains the entry groups to list. Can be provided as a URL. |
pageToken | string The token returned from the previous request. A value of |
pageSize | int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerableListEntryGroupsResponseEntryGroup | A pageable asynchronous sequence of EntryGroup resources. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedAsyncEnumerable<ListEntryGroupsResponse, EntryGroup> response = dataCatalogClient.ListEntryGroupsAsync(parent);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((EntryGroup item) =>
{
// Do something with each item
Console.WriteLine(item);
});
// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListEntryGroupsResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (EntryGroup item in page)
{
// Do something with each item
Console.WriteLine(item);
}
});
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<EntryGroup> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (EntryGroup item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListEntryGroupsAsync(ListEntryGroupsRequest, CallSettings)
public virtual 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. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
ListEntryGroupsRequest request = new ListEntryGroupsRequest
{
ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
PagedAsyncEnumerable<ListEntryGroupsResponse, EntryGroup> response = dataCatalogClient.ListEntryGroupsAsync(request);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((EntryGroup item) =>
{
// Do something with each item
Console.WriteLine(item);
});
// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListEntryGroupsResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (EntryGroup item in page)
{
// Do something with each item
Console.WriteLine(item);
}
});
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<EntryGroup> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (EntryGroup item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListEntryGroupsAsync(string, string, int?, CallSettings)
public virtual PagedAsyncEnumerable<ListEntryGroupsResponse, EntryGroup> ListEntryGroupsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Lists entry groups.
Parameters | |
---|---|
Name | Description |
parent | string Required. The name of the location that contains the entry groups to list. Can be provided as a URL. |
pageToken | string The token returned from the previous request. A value of |
pageSize | int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerableListEntryGroupsResponseEntryGroup | A pageable asynchronous sequence of EntryGroup resources. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedAsyncEnumerable<ListEntryGroupsResponse, EntryGroup> response = dataCatalogClient.ListEntryGroupsAsync(parent);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((EntryGroup item) =>
{
// Do something with each item
Console.WriteLine(item);
});
// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListEntryGroupsResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (EntryGroup item in page)
{
// Do something with each item
Console.WriteLine(item);
}
});
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<EntryGroup> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (EntryGroup item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListTags(EntryName, string, int?, CallSettings)
public virtual PagedEnumerable<ListTagsResponse, Tag> ListTags(EntryName parent, string pageToken = null, int? pageSize = null, 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 |
parent | EntryName Required. The name of the Data Catalog resource to list the tags of. The resource can be an [Entry][google.cloud.datacatalog.v1.Entry]
or an [EntryGroup][google.cloud.datacatalog.v1.EntryGroup]
(without |
pageToken | string The token returned from the previous request. A value of |
pageSize | int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerableListTagsResponseTag | A pageable sequence of Tag resources. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
EntryName parent = EntryName.FromProjectLocationEntryGroupEntry("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
// Make the request
PagedEnumerable<ListTagsResponse, Tag> response = dataCatalogClient.ListTags(parent);
// Iterate over all response items, lazily performing RPCs as required
foreach (Tag item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListTagsResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Tag item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Tag> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Tag item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListTags(ListTagsRequest, CallSettings)
public virtual 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. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
ListTagsRequest request = new ListTagsRequest
{
ParentAsEntryName = EntryName.FromProjectLocationEntryGroupEntry("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]"),
};
// Make the request
PagedEnumerable<ListTagsResponse, Tag> response = dataCatalogClient.ListTags(request);
// Iterate over all response items, lazily performing RPCs as required
foreach (Tag item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListTagsResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Tag item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Tag> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Tag item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListTags(string, string, int?, CallSettings)
public virtual PagedEnumerable<ListTagsResponse, Tag> ListTags(string parent, string pageToken = null, int? pageSize = null, 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 |
parent | string Required. The name of the Data Catalog resource to list the tags of. The resource can be an [Entry][google.cloud.datacatalog.v1.Entry]
or an [EntryGroup][google.cloud.datacatalog.v1.EntryGroup]
(without |
pageToken | string The token returned from the previous request. A value of |
pageSize | int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerableListTagsResponseTag | A pageable sequence of Tag resources. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/entryGroups/[ENTRY_GROUP]/entries/[ENTRY]";
// Make the request
PagedEnumerable<ListTagsResponse, Tag> response = dataCatalogClient.ListTags(parent);
// Iterate over all response items, lazily performing RPCs as required
foreach (Tag item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListTagsResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Tag item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Tag> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Tag item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListTagsAsync(EntryName, string, int?, CallSettings)
public virtual PagedAsyncEnumerable<ListTagsResponse, Tag> ListTagsAsync(EntryName parent, string pageToken = null, int? pageSize = null, 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 |
parent | EntryName Required. The name of the Data Catalog resource to list the tags of. The resource can be an [Entry][google.cloud.datacatalog.v1.Entry]
or an [EntryGroup][google.cloud.datacatalog.v1.EntryGroup]
(without |
pageToken | string The token returned from the previous request. A value of |
pageSize | int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerableListTagsResponseTag | A pageable asynchronous sequence of Tag resources. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
EntryName parent = EntryName.FromProjectLocationEntryGroupEntry("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
// Make the request
PagedAsyncEnumerable<ListTagsResponse, Tag> response = dataCatalogClient.ListTagsAsync(parent);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Tag item) =>
{
// Do something with each item
Console.WriteLine(item);
});
// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListTagsResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Tag item in page)
{
// Do something with each item
Console.WriteLine(item);
}
});
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Tag> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Tag item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListTagsAsync(ListTagsRequest, CallSettings)
public virtual 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. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
ListTagsRequest request = new ListTagsRequest
{
ParentAsEntryName = EntryName.FromProjectLocationEntryGroupEntry("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]"),
};
// Make the request
PagedAsyncEnumerable<ListTagsResponse, Tag> response = dataCatalogClient.ListTagsAsync(request);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Tag item) =>
{
// Do something with each item
Console.WriteLine(item);
});
// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListTagsResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Tag item in page)
{
// Do something with each item
Console.WriteLine(item);
}
});
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Tag> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Tag item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListTagsAsync(string, string, int?, CallSettings)
public virtual PagedAsyncEnumerable<ListTagsResponse, Tag> ListTagsAsync(string parent, string pageToken = null, int? pageSize = null, 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 |
parent | string Required. The name of the Data Catalog resource to list the tags of. The resource can be an [Entry][google.cloud.datacatalog.v1.Entry]
or an [EntryGroup][google.cloud.datacatalog.v1.EntryGroup]
(without |
pageToken | string The token returned from the previous request. A value of |
pageSize | int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerableListTagsResponseTag | A pageable asynchronous sequence of Tag resources. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/entryGroups/[ENTRY_GROUP]/entries/[ENTRY]";
// Make the request
PagedAsyncEnumerable<ListTagsResponse, Tag> response = dataCatalogClient.ListTagsAsync(parent);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Tag item) =>
{
// Do something with each item
Console.WriteLine(item);
});
// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListTagsResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Tag item in page)
{
// Do something with each item
Console.WriteLine(item);
}
});
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Tag> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Tag item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
LookupEntry(LookupEntryRequest, CallSettings)
public virtual 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. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
LookupEntryRequest request = new LookupEntryRequest
{
LinkedResource = "",
Project = "",
Location = "",
};
// Make the request
Entry response = dataCatalogClient.LookupEntry(request);
LookupEntryAsync(LookupEntryRequest, CallSettings)
public virtual 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. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
LookupEntryRequest request = new LookupEntryRequest
{
LinkedResource = "",
Project = "",
Location = "",
};
// Make the request
Entry response = await dataCatalogClient.LookupEntryAsync(request);
LookupEntryAsync(LookupEntryRequest, CancellationToken)
public virtual Task<Entry> LookupEntryAsync(LookupEntryRequest request, CancellationToken cancellationToken)
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. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskEntry | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
LookupEntryRequest request = new LookupEntryRequest
{
LinkedResource = "",
Project = "",
Location = "",
};
// Make the request
Entry response = await dataCatalogClient.LookupEntryAsync(request);
ModifyEntryContacts(ModifyEntryContactsRequest, CallSettings)
public virtual 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. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
ModifyEntryContactsRequest request = new ModifyEntryContactsRequest
{
EntryName = EntryName.FromProjectLocationEntryGroupEntry("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]"),
Contacts = new Contacts(),
};
// Make the request
Contacts response = dataCatalogClient.ModifyEntryContacts(request);
ModifyEntryContactsAsync(ModifyEntryContactsRequest, CallSettings)
public virtual 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. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
ModifyEntryContactsRequest request = new ModifyEntryContactsRequest
{
EntryName = EntryName.FromProjectLocationEntryGroupEntry("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]"),
Contacts = new Contacts(),
};
// Make the request
Contacts response = await dataCatalogClient.ModifyEntryContactsAsync(request);
ModifyEntryContactsAsync(ModifyEntryContactsRequest, CancellationToken)
public virtual Task<Contacts> ModifyEntryContactsAsync(ModifyEntryContactsRequest request, CancellationToken cancellationToken)
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. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskContacts | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
ModifyEntryContactsRequest request = new ModifyEntryContactsRequest
{
EntryName = EntryName.FromProjectLocationEntryGroupEntry("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]"),
Contacts = new Contacts(),
};
// Make the request
Contacts response = await dataCatalogClient.ModifyEntryContactsAsync(request);
ModifyEntryOverview(ModifyEntryOverviewRequest, CallSettings)
public virtual 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. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
ModifyEntryOverviewRequest request = new ModifyEntryOverviewRequest
{
EntryName = EntryName.FromProjectLocationEntryGroupEntry("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]"),
EntryOverview = new EntryOverview(),
};
// Make the request
EntryOverview response = dataCatalogClient.ModifyEntryOverview(request);
ModifyEntryOverviewAsync(ModifyEntryOverviewRequest, CallSettings)
public virtual 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. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
ModifyEntryOverviewRequest request = new ModifyEntryOverviewRequest
{
EntryName = EntryName.FromProjectLocationEntryGroupEntry("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]"),
EntryOverview = new EntryOverview(),
};
// Make the request
EntryOverview response = await dataCatalogClient.ModifyEntryOverviewAsync(request);
ModifyEntryOverviewAsync(ModifyEntryOverviewRequest, CancellationToken)
public virtual Task<EntryOverview> ModifyEntryOverviewAsync(ModifyEntryOverviewRequest request, CancellationToken cancellationToken)
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. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskEntryOverview | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
ModifyEntryOverviewRequest request = new ModifyEntryOverviewRequest
{
EntryName = EntryName.FromProjectLocationEntryGroupEntry("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]"),
EntryOverview = new EntryOverview(),
};
// Make the request
EntryOverview response = await dataCatalogClient.ModifyEntryOverviewAsync(request);
PollOnceImportEntries(string, CallSettings)
public virtual Operation<ImportEntriesResponse, ImportEntriesMetadata> PollOnceImportEntries(string operationName, CallSettings callSettings = null)
Poll an operation once, using an operationName
from a previous invocation of ImportEntries
.
Parameters | |
---|---|
Name | Description |
operationName | string The name of a previously invoked operation. Must not be |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
OperationImportEntriesResponseImportEntriesMetadata | The result of polling the operation. |
PollOnceImportEntriesAsync(string, CallSettings)
public virtual Task<Operation<ImportEntriesResponse, ImportEntriesMetadata>> PollOnceImportEntriesAsync(string operationName, CallSettings callSettings = null)
Asynchronously poll an operation once, using an operationName
from a previous invocation of
ImportEntries
.
Parameters | |
---|---|
Name | Description |
operationName | string The name of a previously invoked operation. Must not be |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskOperationImportEntriesResponseImportEntriesMetadata | A task representing the result of polling the operation. |
PollOnceReconcileTags(string, CallSettings)
public virtual Operation<ReconcileTagsResponse, ReconcileTagsMetadata> PollOnceReconcileTags(string operationName, CallSettings callSettings = null)
Poll an operation once, using an operationName
from a previous invocation of ReconcileTags
.
Parameters | |
---|---|
Name | Description |
operationName | string The name of a previously invoked operation. Must not be |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
OperationReconcileTagsResponseReconcileTagsMetadata | The result of polling the operation. |
PollOnceReconcileTagsAsync(string, CallSettings)
public virtual Task<Operation<ReconcileTagsResponse, ReconcileTagsMetadata>> PollOnceReconcileTagsAsync(string operationName, CallSettings callSettings = null)
Asynchronously poll an operation once, using an operationName
from a previous invocation of
ReconcileTags
.
Parameters | |
---|---|
Name | Description |
operationName | string The name of a previously invoked operation. Must not be |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskOperationReconcileTagsResponseReconcileTagsMetadata | A task representing the result of polling the operation. |
ReconcileTags(ReconcileTagsRequest, CallSettings)
public virtual 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. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
ReconcileTagsRequest request = new ReconcileTagsRequest
{
ParentAsEntryName = EntryName.FromProjectLocationEntryGroupEntry("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]"),
TagTemplateAsTagTemplateName = TagTemplateName.FromProjectLocationTagTemplate("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]"),
ForceDeleteMissing = false,
Tags = { new Tag(), },
};
// Make the request
Operation<ReconcileTagsResponse, ReconcileTagsMetadata> response = dataCatalogClient.ReconcileTags(request);
// Poll until the returned long-running operation is complete
Operation<ReconcileTagsResponse, ReconcileTagsMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
ReconcileTagsResponse result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ReconcileTagsResponse, ReconcileTagsMetadata> retrievedResponse = dataCatalogClient.PollOnceReconcileTags(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
ReconcileTagsResponse retrievedResult = retrievedResponse.Result;
}
ReconcileTagsAsync(ReconcileTagsRequest, CallSettings)
public virtual 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. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
ReconcileTagsRequest request = new ReconcileTagsRequest
{
ParentAsEntryName = EntryName.FromProjectLocationEntryGroupEntry("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]"),
TagTemplateAsTagTemplateName = TagTemplateName.FromProjectLocationTagTemplate("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]"),
ForceDeleteMissing = false,
Tags = { new Tag(), },
};
// Make the request
Operation<ReconcileTagsResponse, ReconcileTagsMetadata> response = await dataCatalogClient.ReconcileTagsAsync(request);
// Poll until the returned long-running operation is complete
Operation<ReconcileTagsResponse, ReconcileTagsMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
ReconcileTagsResponse result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ReconcileTagsResponse, ReconcileTagsMetadata> retrievedResponse = await dataCatalogClient.PollOnceReconcileTagsAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
ReconcileTagsResponse retrievedResult = retrievedResponse.Result;
}
ReconcileTagsAsync(ReconcileTagsRequest, CancellationToken)
public virtual Task<Operation<ReconcileTagsResponse, ReconcileTagsMetadata>> ReconcileTagsAsync(ReconcileTagsRequest request, CancellationToken cancellationToken)
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. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskOperationReconcileTagsResponseReconcileTagsMetadata | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
ReconcileTagsRequest request = new ReconcileTagsRequest
{
ParentAsEntryName = EntryName.FromProjectLocationEntryGroupEntry("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]"),
TagTemplateAsTagTemplateName = TagTemplateName.FromProjectLocationTagTemplate("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]"),
ForceDeleteMissing = false,
Tags = { new Tag(), },
};
// Make the request
Operation<ReconcileTagsResponse, ReconcileTagsMetadata> response = await dataCatalogClient.ReconcileTagsAsync(request);
// Poll until the returned long-running operation is complete
Operation<ReconcileTagsResponse, ReconcileTagsMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
ReconcileTagsResponse result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ReconcileTagsResponse, ReconcileTagsMetadata> retrievedResponse = await dataCatalogClient.PollOnceReconcileTagsAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
ReconcileTagsResponse retrievedResult = retrievedResponse.Result;
}
RenameTagTemplateField(RenameTagTemplateFieldRequest, CallSettings)
public virtual 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. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
RenameTagTemplateFieldRequest request = new RenameTagTemplateFieldRequest
{
TagTemplateFieldName = TagTemplateFieldName.FromProjectLocationTagTemplateField("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]"),
NewTagTemplateFieldId = "",
};
// Make the request
TagTemplateField response = dataCatalogClient.RenameTagTemplateField(request);
RenameTagTemplateField(TagTemplateFieldName, string, CallSettings)
public virtual TagTemplateField RenameTagTemplateField(TagTemplateFieldName name, string newTagTemplateFieldId, 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 |
name | TagTemplateFieldName Required. The name of the tag template field. |
newTagTemplateFieldId | string Required. The new ID of this tag template field. For example,
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TagTemplateField | The RPC response. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
TagTemplateFieldName name = TagTemplateFieldName.FromProjectLocationTagTemplateField("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]");
string newTagTemplateFieldId = "";
// Make the request
TagTemplateField response = dataCatalogClient.RenameTagTemplateField(name, newTagTemplateFieldId);
RenameTagTemplateField(string, string, CallSettings)
public virtual TagTemplateField RenameTagTemplateField(string name, string newTagTemplateFieldId, 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 |
name | string Required. The name of the tag template field. |
newTagTemplateFieldId | string Required. The new ID of this tag template field. For example,
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TagTemplateField | The RPC response. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/tagTemplates/[TAG_TEMPLATE]/fields/[FIELD]";
string newTagTemplateFieldId = "";
// Make the request
TagTemplateField response = dataCatalogClient.RenameTagTemplateField(name, newTagTemplateFieldId);
RenameTagTemplateFieldAsync(RenameTagTemplateFieldRequest, CallSettings)
public virtual 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. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
RenameTagTemplateFieldRequest request = new RenameTagTemplateFieldRequest
{
TagTemplateFieldName = TagTemplateFieldName.FromProjectLocationTagTemplateField("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]"),
NewTagTemplateFieldId = "",
};
// Make the request
TagTemplateField response = await dataCatalogClient.RenameTagTemplateFieldAsync(request);
RenameTagTemplateFieldAsync(RenameTagTemplateFieldRequest, CancellationToken)
public virtual Task<TagTemplateField> RenameTagTemplateFieldAsync(RenameTagTemplateFieldRequest request, CancellationToken cancellationToken)
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. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskTagTemplateField | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
RenameTagTemplateFieldRequest request = new RenameTagTemplateFieldRequest
{
TagTemplateFieldName = TagTemplateFieldName.FromProjectLocationTagTemplateField("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]"),
NewTagTemplateFieldId = "",
};
// Make the request
TagTemplateField response = await dataCatalogClient.RenameTagTemplateFieldAsync(request);
RenameTagTemplateFieldAsync(TagTemplateFieldName, string, CallSettings)
public virtual Task<TagTemplateField> RenameTagTemplateFieldAsync(TagTemplateFieldName name, string newTagTemplateFieldId, 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 |
name | TagTemplateFieldName Required. The name of the tag template field. |
newTagTemplateFieldId | string Required. The new ID of this tag template field. For example,
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskTagTemplateField | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
TagTemplateFieldName name = TagTemplateFieldName.FromProjectLocationTagTemplateField("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]");
string newTagTemplateFieldId = "";
// Make the request
TagTemplateField response = await dataCatalogClient.RenameTagTemplateFieldAsync(name, newTagTemplateFieldId);
RenameTagTemplateFieldAsync(TagTemplateFieldName, string, CancellationToken)
public virtual Task<TagTemplateField> RenameTagTemplateFieldAsync(TagTemplateFieldName name, string newTagTemplateFieldId, CancellationToken cancellationToken)
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 |
name | TagTemplateFieldName Required. The name of the tag template field. |
newTagTemplateFieldId | string Required. The new ID of this tag template field. For example,
|
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskTagTemplateField | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
TagTemplateFieldName name = TagTemplateFieldName.FromProjectLocationTagTemplateField("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]");
string newTagTemplateFieldId = "";
// Make the request
TagTemplateField response = await dataCatalogClient.RenameTagTemplateFieldAsync(name, newTagTemplateFieldId);
RenameTagTemplateFieldAsync(string, string, CallSettings)
public virtual Task<TagTemplateField> RenameTagTemplateFieldAsync(string name, string newTagTemplateFieldId, 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 |
name | string Required. The name of the tag template field. |
newTagTemplateFieldId | string Required. The new ID of this tag template field. For example,
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskTagTemplateField | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/tagTemplates/[TAG_TEMPLATE]/fields/[FIELD]";
string newTagTemplateFieldId = "";
// Make the request
TagTemplateField response = await dataCatalogClient.RenameTagTemplateFieldAsync(name, newTagTemplateFieldId);
RenameTagTemplateFieldAsync(string, string, CancellationToken)
public virtual Task<TagTemplateField> RenameTagTemplateFieldAsync(string name, string newTagTemplateFieldId, CancellationToken cancellationToken)
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 |
name | string Required. The name of the tag template field. |
newTagTemplateFieldId | string Required. The new ID of this tag template field. For example,
|
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskTagTemplateField | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/tagTemplates/[TAG_TEMPLATE]/fields/[FIELD]";
string newTagTemplateFieldId = "";
// Make the request
TagTemplateField response = await dataCatalogClient.RenameTagTemplateFieldAsync(name, newTagTemplateFieldId);
RenameTagTemplateFieldEnumValue(RenameTagTemplateFieldEnumValueRequest, CallSettings)
public virtual 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. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
RenameTagTemplateFieldEnumValueRequest request = new RenameTagTemplateFieldEnumValueRequest
{
TagTemplateFieldEnumValueName = TagTemplateFieldEnumValueName.FromProjectLocationTagTemplateTagTemplateFieldEnumValueDisplayName("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[TAG_TEMPLATE_FIELD_ID]", "[ENUM_VALUE_DISPLAY_NAME]"),
NewEnumValueDisplayName = "",
};
// Make the request
TagTemplateField response = dataCatalogClient.RenameTagTemplateFieldEnumValue(request);
RenameTagTemplateFieldEnumValue(TagTemplateFieldEnumValueName, string, CallSettings)
public virtual TagTemplateField RenameTagTemplateFieldEnumValue(TagTemplateFieldEnumValueName name, string newEnumValueDisplayName, CallSettings callSettings = null)
Renames an enum value in a tag template.
Within a single enum field, enum values must be unique.
Parameters | |
---|---|
Name | Description |
name | TagTemplateFieldEnumValueName Required. The name of the enum field value. |
newEnumValueDisplayName | string Required. The new display name of the enum value. For example,
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TagTemplateField | The RPC response. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
TagTemplateFieldEnumValueName name = TagTemplateFieldEnumValueName.FromProjectLocationTagTemplateTagTemplateFieldEnumValueDisplayName("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[TAG_TEMPLATE_FIELD_ID]", "[ENUM_VALUE_DISPLAY_NAME]");
string newEnumValueDisplayName = "";
// Make the request
TagTemplateField response = dataCatalogClient.RenameTagTemplateFieldEnumValue(name, newEnumValueDisplayName);
RenameTagTemplateFieldEnumValue(string, string, CallSettings)
public virtual TagTemplateField RenameTagTemplateFieldEnumValue(string name, string newEnumValueDisplayName, CallSettings callSettings = null)
Renames an enum value in a tag template.
Within a single enum field, enum values must be unique.
Parameters | |
---|---|
Name | Description |
name | string Required. The name of the enum field value. |
newEnumValueDisplayName | string Required. The new display name of the enum value. For example,
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TagTemplateField | The RPC response. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/tagTemplates/[TAG_TEMPLATE]/fields/[TAG_TEMPLATE_FIELD_ID]/enumValues/[ENUM_VALUE_DISPLAY_NAME]";
string newEnumValueDisplayName = "";
// Make the request
TagTemplateField response = dataCatalogClient.RenameTagTemplateFieldEnumValue(name, newEnumValueDisplayName);
RenameTagTemplateFieldEnumValueAsync(RenameTagTemplateFieldEnumValueRequest, CallSettings)
public virtual 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. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
RenameTagTemplateFieldEnumValueRequest request = new RenameTagTemplateFieldEnumValueRequest
{
TagTemplateFieldEnumValueName = TagTemplateFieldEnumValueName.FromProjectLocationTagTemplateTagTemplateFieldEnumValueDisplayName("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[TAG_TEMPLATE_FIELD_ID]", "[ENUM_VALUE_DISPLAY_NAME]"),
NewEnumValueDisplayName = "",
};
// Make the request
TagTemplateField response = await dataCatalogClient.RenameTagTemplateFieldEnumValueAsync(request);
RenameTagTemplateFieldEnumValueAsync(RenameTagTemplateFieldEnumValueRequest, CancellationToken)
public virtual Task<TagTemplateField> RenameTagTemplateFieldEnumValueAsync(RenameTagTemplateFieldEnumValueRequest request, CancellationToken cancellationToken)
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. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskTagTemplateField | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
RenameTagTemplateFieldEnumValueRequest request = new RenameTagTemplateFieldEnumValueRequest
{
TagTemplateFieldEnumValueName = TagTemplateFieldEnumValueName.FromProjectLocationTagTemplateTagTemplateFieldEnumValueDisplayName("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[TAG_TEMPLATE_FIELD_ID]", "[ENUM_VALUE_DISPLAY_NAME]"),
NewEnumValueDisplayName = "",
};
// Make the request
TagTemplateField response = await dataCatalogClient.RenameTagTemplateFieldEnumValueAsync(request);
RenameTagTemplateFieldEnumValueAsync(TagTemplateFieldEnumValueName, string, CallSettings)
public virtual Task<TagTemplateField> RenameTagTemplateFieldEnumValueAsync(TagTemplateFieldEnumValueName name, string newEnumValueDisplayName, CallSettings callSettings = null)
Renames an enum value in a tag template.
Within a single enum field, enum values must be unique.
Parameters | |
---|---|
Name | Description |
name | TagTemplateFieldEnumValueName Required. The name of the enum field value. |
newEnumValueDisplayName | string Required. The new display name of the enum value. For example,
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskTagTemplateField | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
TagTemplateFieldEnumValueName name = TagTemplateFieldEnumValueName.FromProjectLocationTagTemplateTagTemplateFieldEnumValueDisplayName("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[TAG_TEMPLATE_FIELD_ID]", "[ENUM_VALUE_DISPLAY_NAME]");
string newEnumValueDisplayName = "";
// Make the request
TagTemplateField response = await dataCatalogClient.RenameTagTemplateFieldEnumValueAsync(name, newEnumValueDisplayName);
RenameTagTemplateFieldEnumValueAsync(TagTemplateFieldEnumValueName, string, CancellationToken)
public virtual Task<TagTemplateField> RenameTagTemplateFieldEnumValueAsync(TagTemplateFieldEnumValueName name, string newEnumValueDisplayName, CancellationToken cancellationToken)
Renames an enum value in a tag template.
Within a single enum field, enum values must be unique.
Parameters | |
---|---|
Name | Description |
name | TagTemplateFieldEnumValueName Required. The name of the enum field value. |
newEnumValueDisplayName | string Required. The new display name of the enum value. For example,
|
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskTagTemplateField | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
TagTemplateFieldEnumValueName name = TagTemplateFieldEnumValueName.FromProjectLocationTagTemplateTagTemplateFieldEnumValueDisplayName("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[TAG_TEMPLATE_FIELD_ID]", "[ENUM_VALUE_DISPLAY_NAME]");
string newEnumValueDisplayName = "";
// Make the request
TagTemplateField response = await dataCatalogClient.RenameTagTemplateFieldEnumValueAsync(name, newEnumValueDisplayName);
RenameTagTemplateFieldEnumValueAsync(string, string, CallSettings)
public virtual Task<TagTemplateField> RenameTagTemplateFieldEnumValueAsync(string name, string newEnumValueDisplayName, CallSettings callSettings = null)
Renames an enum value in a tag template.
Within a single enum field, enum values must be unique.
Parameters | |
---|---|
Name | Description |
name | string Required. The name of the enum field value. |
newEnumValueDisplayName | string Required. The new display name of the enum value. For example,
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskTagTemplateField | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/tagTemplates/[TAG_TEMPLATE]/fields/[TAG_TEMPLATE_FIELD_ID]/enumValues/[ENUM_VALUE_DISPLAY_NAME]";
string newEnumValueDisplayName = "";
// Make the request
TagTemplateField response = await dataCatalogClient.RenameTagTemplateFieldEnumValueAsync(name, newEnumValueDisplayName);
RenameTagTemplateFieldEnumValueAsync(string, string, CancellationToken)
public virtual Task<TagTemplateField> RenameTagTemplateFieldEnumValueAsync(string name, string newEnumValueDisplayName, CancellationToken cancellationToken)
Renames an enum value in a tag template.
Within a single enum field, enum values must be unique.
Parameters | |
---|---|
Name | Description |
name | string Required. The name of the enum field value. |
newEnumValueDisplayName | string Required. The new display name of the enum value. For example,
|
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskTagTemplateField | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/tagTemplates/[TAG_TEMPLATE]/fields/[TAG_TEMPLATE_FIELD_ID]/enumValues/[ENUM_VALUE_DISPLAY_NAME]";
string newEnumValueDisplayName = "";
// Make the request
TagTemplateField response = await dataCatalogClient.RenameTagTemplateFieldEnumValueAsync(name, newEnumValueDisplayName);
SearchCatalog(SearchCatalogRequest, CallSettings)
public virtual 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. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
SearchCatalogRequest request = new SearchCatalogRequest
{
Query = "",
OrderBy = "",
Scope = new SearchCatalogRequest.Types.Scope(),
};
// Make the request
PagedEnumerable<SearchCatalogResponse, SearchCatalogResult> response = dataCatalogClient.SearchCatalog(request);
// Iterate over all response items, lazily performing RPCs as required
foreach (SearchCatalogResult item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (SearchCatalogResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (SearchCatalogResult item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<SearchCatalogResult> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (SearchCatalogResult item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
SearchCatalog(Scope, string, string, int?, CallSettings)
public virtual PagedEnumerable<SearchCatalogResponse, SearchCatalogResult> SearchCatalog(SearchCatalogRequest.Types.Scope scope, string query, string pageToken = null, int? pageSize = null, 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 |
scope | SearchCatalogRequestTypesScope Required. The scope of this search request. The |
query | string Optional. The query string with a minimum of 3 characters and specific syntax. For more information, see Data Catalog search syntax. An empty query string returns all data assets (in the specified scope) that you have access to. A query string can be a simple
|
pageToken | string The token returned from the previous request. A value of |
pageSize | int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerableSearchCatalogResponseSearchCatalogResult | A pageable sequence of SearchCatalogResult resources. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
SearchCatalogRequest.Types.Scope scope = new SearchCatalogRequest.Types.Scope();
string query = "";
// Make the request
PagedEnumerable<SearchCatalogResponse, SearchCatalogResult> response = dataCatalogClient.SearchCatalog(scope, query);
// Iterate over all response items, lazily performing RPCs as required
foreach (SearchCatalogResult item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (SearchCatalogResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (SearchCatalogResult item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<SearchCatalogResult> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (SearchCatalogResult item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
SearchCatalogAsync(SearchCatalogRequest, CallSettings)
public virtual 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. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
SearchCatalogRequest request = new SearchCatalogRequest
{
Query = "",
OrderBy = "",
Scope = new SearchCatalogRequest.Types.Scope(),
};
// Make the request
PagedAsyncEnumerable<SearchCatalogResponse, SearchCatalogResult> response = dataCatalogClient.SearchCatalogAsync(request);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((SearchCatalogResult item) =>
{
// Do something with each item
Console.WriteLine(item);
});
// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((SearchCatalogResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (SearchCatalogResult item in page)
{
// Do something with each item
Console.WriteLine(item);
}
});
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<SearchCatalogResult> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (SearchCatalogResult item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
SearchCatalogAsync(Scope, string, string, int?, CallSettings)
public virtual PagedAsyncEnumerable<SearchCatalogResponse, SearchCatalogResult> SearchCatalogAsync(SearchCatalogRequest.Types.Scope scope, string query, string pageToken = null, int? pageSize = null, 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 |
scope | SearchCatalogRequestTypesScope Required. The scope of this search request. The |
query | string Optional. The query string with a minimum of 3 characters and specific syntax. For more information, see Data Catalog search syntax. An empty query string returns all data assets (in the specified scope) that you have access to. A query string can be a simple
|
pageToken | string The token returned from the previous request. A value of |
pageSize | int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerableSearchCatalogResponseSearchCatalogResult | A pageable asynchronous sequence of SearchCatalogResult resources. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
SearchCatalogRequest.Types.Scope scope = new SearchCatalogRequest.Types.Scope();
string query = "";
// Make the request
PagedAsyncEnumerable<SearchCatalogResponse, SearchCatalogResult> response = dataCatalogClient.SearchCatalogAsync(scope, query);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((SearchCatalogResult item) =>
{
// Do something with each item
Console.WriteLine(item);
});
// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((SearchCatalogResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (SearchCatalogResult item in page)
{
// Do something with each item
Console.WriteLine(item);
}
});
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<SearchCatalogResult> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (SearchCatalogResult item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
SetIamPolicy(IResourceName, Policy, CallSettings)
public virtual Policy SetIamPolicy(IResourceName resource, Policy policy, 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 |
resource | IResourceName REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. |
policy | Policy REQUIRED: The complete policy to be applied to the |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Policy | The RPC response. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
IResourceName resource = new UnparsedResourceName("a/wildcard/resource");
Policy policy = new Policy();
// Make the request
Policy response = dataCatalogClient.SetIamPolicy(resource, policy);
SetIamPolicy(SetIamPolicyRequest, CallSettings)
public virtual 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. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
SetIamPolicyRequest request = new SetIamPolicyRequest
{
ResourceAsResourceName = new UnparsedResourceName("a/wildcard/resource"),
Policy = new Policy(),
UpdateMask = new FieldMask(),
};
// Make the request
Policy response = dataCatalogClient.SetIamPolicy(request);
SetIamPolicy(string, Policy, CallSettings)
public virtual Policy SetIamPolicy(string resource, Policy policy, 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 |
resource | string REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. |
policy | Policy REQUIRED: The complete policy to be applied to the |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Policy | The RPC response. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
string resource = "a/wildcard/resource";
Policy policy = new Policy();
// Make the request
Policy response = dataCatalogClient.SetIamPolicy(resource, policy);
SetIamPolicyAsync(IResourceName, Policy, CallSettings)
public virtual Task<Policy> SetIamPolicyAsync(IResourceName resource, Policy policy, 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 |
resource | IResourceName REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. |
policy | Policy REQUIRED: The complete policy to be applied to the |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskPolicy | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
IResourceName resource = new UnparsedResourceName("a/wildcard/resource");
Policy policy = new Policy();
// Make the request
Policy response = await dataCatalogClient.SetIamPolicyAsync(resource, policy);
SetIamPolicyAsync(IResourceName, Policy, CancellationToken)
public virtual Task<Policy> SetIamPolicyAsync(IResourceName resource, Policy policy, CancellationToken cancellationToken)
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 |
resource | IResourceName REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. |
policy | Policy REQUIRED: The complete policy to be applied to the |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskPolicy | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
IResourceName resource = new UnparsedResourceName("a/wildcard/resource");
Policy policy = new Policy();
// Make the request
Policy response = await dataCatalogClient.SetIamPolicyAsync(resource, policy);
SetIamPolicyAsync(SetIamPolicyRequest, CallSettings)
public virtual 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. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
SetIamPolicyRequest request = new SetIamPolicyRequest
{
ResourceAsResourceName = new UnparsedResourceName("a/wildcard/resource"),
Policy = new Policy(),
UpdateMask = new FieldMask(),
};
// Make the request
Policy response = await dataCatalogClient.SetIamPolicyAsync(request);
SetIamPolicyAsync(SetIamPolicyRequest, CancellationToken)
public virtual Task<Policy> SetIamPolicyAsync(SetIamPolicyRequest request, CancellationToken cancellationToken)
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. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskPolicy | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
SetIamPolicyRequest request = new SetIamPolicyRequest
{
ResourceAsResourceName = new UnparsedResourceName("a/wildcard/resource"),
Policy = new Policy(),
UpdateMask = new FieldMask(),
};
// Make the request
Policy response = await dataCatalogClient.SetIamPolicyAsync(request);
SetIamPolicyAsync(string, Policy, CallSettings)
public virtual Task<Policy> SetIamPolicyAsync(string resource, Policy policy, 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 |
resource | string REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. |
policy | Policy REQUIRED: The complete policy to be applied to the |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskPolicy | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
string resource = "a/wildcard/resource";
Policy policy = new Policy();
// Make the request
Policy response = await dataCatalogClient.SetIamPolicyAsync(resource, policy);
SetIamPolicyAsync(string, Policy, CancellationToken)
public virtual Task<Policy> SetIamPolicyAsync(string resource, Policy policy, CancellationToken cancellationToken)
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 |
resource | string REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. |
policy | Policy REQUIRED: The complete policy to be applied to the |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskPolicy | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
string resource = "a/wildcard/resource";
Policy policy = new Policy();
// Make the request
Policy response = await dataCatalogClient.SetIamPolicyAsync(resource, policy);
ShutdownDefaultChannelsAsync()
public static Task ShutdownDefaultChannelsAsync()
Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.
Returns | |
---|---|
Type | Description |
Task | A task representing the asynchronous shutdown operation. |
After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.
StarEntry(EntryName, CallSettings)
public virtual StarEntryResponse StarEntry(EntryName name, 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 |
name | EntryName Required. The name of the entry to mark as starred. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
StarEntryResponse | The RPC response. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
EntryName name = EntryName.FromProjectLocationEntryGroupEntry("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
// Make the request
StarEntryResponse response = dataCatalogClient.StarEntry(name);
StarEntry(StarEntryRequest, CallSettings)
public virtual 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. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
StarEntryRequest request = new StarEntryRequest
{
EntryName = EntryName.FromProjectLocationEntryGroupEntry("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]"),
};
// Make the request
StarEntryResponse response = dataCatalogClient.StarEntry(request);
StarEntry(string, CallSettings)
public virtual StarEntryResponse StarEntry(string name, 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 |
name | string Required. The name of the entry to mark as starred. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
StarEntryResponse | The RPC response. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/entryGroups/[ENTRY_GROUP]/entries/[ENTRY]";
// Make the request
StarEntryResponse response = dataCatalogClient.StarEntry(name);
StarEntryAsync(EntryName, CallSettings)
public virtual Task<StarEntryResponse> StarEntryAsync(EntryName name, 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 |
name | EntryName Required. The name of the entry to mark as starred. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskStarEntryResponse | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
EntryName name = EntryName.FromProjectLocationEntryGroupEntry("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
// Make the request
StarEntryResponse response = await dataCatalogClient.StarEntryAsync(name);
StarEntryAsync(EntryName, CancellationToken)
public virtual Task<StarEntryResponse> StarEntryAsync(EntryName name, CancellationToken cancellationToken)
Marks an [Entry][google.cloud.datacatalog.v1.Entry] as starred by the current user. Starring information is private to each user.
Parameters | |
---|---|
Name | Description |
name | EntryName Required. The name of the entry to mark as starred. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskStarEntryResponse | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
EntryName name = EntryName.FromProjectLocationEntryGroupEntry("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
// Make the request
StarEntryResponse response = await dataCatalogClient.StarEntryAsync(name);
StarEntryAsync(StarEntryRequest, CallSettings)
public virtual 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. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
StarEntryRequest request = new StarEntryRequest
{
EntryName = EntryName.FromProjectLocationEntryGroupEntry("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]"),
};
// Make the request
StarEntryResponse response = await dataCatalogClient.StarEntryAsync(request);
StarEntryAsync(StarEntryRequest, CancellationToken)
public virtual Task<StarEntryResponse> StarEntryAsync(StarEntryRequest request, CancellationToken cancellationToken)
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. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskStarEntryResponse | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
StarEntryRequest request = new StarEntryRequest
{
EntryName = EntryName.FromProjectLocationEntryGroupEntry("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]"),
};
// Make the request
StarEntryResponse response = await dataCatalogClient.StarEntryAsync(request);
StarEntryAsync(string, CallSettings)
public virtual Task<StarEntryResponse> StarEntryAsync(string name, 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 |
name | string Required. The name of the entry to mark as starred. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskStarEntryResponse | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/entryGroups/[ENTRY_GROUP]/entries/[ENTRY]";
// Make the request
StarEntryResponse response = await dataCatalogClient.StarEntryAsync(name);
StarEntryAsync(string, CancellationToken)
public virtual Task<StarEntryResponse> StarEntryAsync(string name, CancellationToken cancellationToken)
Marks an [Entry][google.cloud.datacatalog.v1.Entry] as starred by the current user. Starring information is private to each user.
Parameters | |
---|---|
Name | Description |
name | string Required. The name of the entry to mark as starred. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskStarEntryResponse | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/entryGroups/[ENTRY_GROUP]/entries/[ENTRY]";
// Make the request
StarEntryResponse response = await dataCatalogClient.StarEntryAsync(name);
TestIamPermissions(TestIamPermissionsRequest, CallSettings)
public virtual 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. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
TestIamPermissionsRequest request = new TestIamPermissionsRequest
{
ResourceAsResourceName = new UnparsedResourceName("a/wildcard/resource"),
Permissions = { "", },
};
// Make the request
TestIamPermissionsResponse response = dataCatalogClient.TestIamPermissions(request);
TestIamPermissionsAsync(TestIamPermissionsRequest, CallSettings)
public virtual 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. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
TestIamPermissionsRequest request = new TestIamPermissionsRequest
{
ResourceAsResourceName = new UnparsedResourceName("a/wildcard/resource"),
Permissions = { "", },
};
// Make the request
TestIamPermissionsResponse response = await dataCatalogClient.TestIamPermissionsAsync(request);
TestIamPermissionsAsync(TestIamPermissionsRequest, CancellationToken)
public virtual Task<TestIamPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRequest request, CancellationToken cancellationToken)
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. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskTestIamPermissionsResponse | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
TestIamPermissionsRequest request = new TestIamPermissionsRequest
{
ResourceAsResourceName = new UnparsedResourceName("a/wildcard/resource"),
Permissions = { "", },
};
// Make the request
TestIamPermissionsResponse response = await dataCatalogClient.TestIamPermissionsAsync(request);
UnstarEntry(EntryName, CallSettings)
public virtual UnstarEntryResponse UnstarEntry(EntryName name, 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 |
name | EntryName Required. The name of the entry to mark as not starred. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
UnstarEntryResponse | The RPC response. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
EntryName name = EntryName.FromProjectLocationEntryGroupEntry("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
// Make the request
UnstarEntryResponse response = dataCatalogClient.UnstarEntry(name);
UnstarEntry(UnstarEntryRequest, CallSettings)
public virtual 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. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
UnstarEntryRequest request = new UnstarEntryRequest
{
EntryName = EntryName.FromProjectLocationEntryGroupEntry("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]"),
};
// Make the request
UnstarEntryResponse response = dataCatalogClient.UnstarEntry(request);
UnstarEntry(string, CallSettings)
public virtual UnstarEntryResponse UnstarEntry(string name, 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 |
name | string Required. The name of the entry to mark as not starred. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
UnstarEntryResponse | The RPC response. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/entryGroups/[ENTRY_GROUP]/entries/[ENTRY]";
// Make the request
UnstarEntryResponse response = dataCatalogClient.UnstarEntry(name);
UnstarEntryAsync(EntryName, CallSettings)
public virtual Task<UnstarEntryResponse> UnstarEntryAsync(EntryName name, 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 |
name | EntryName Required. The name of the entry to mark as not starred. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskUnstarEntryResponse | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
EntryName name = EntryName.FromProjectLocationEntryGroupEntry("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
// Make the request
UnstarEntryResponse response = await dataCatalogClient.UnstarEntryAsync(name);
UnstarEntryAsync(EntryName, CancellationToken)
public virtual Task<UnstarEntryResponse> UnstarEntryAsync(EntryName name, CancellationToken cancellationToken)
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 |
name | EntryName Required. The name of the entry to mark as not starred. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskUnstarEntryResponse | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
EntryName name = EntryName.FromProjectLocationEntryGroupEntry("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
// Make the request
UnstarEntryResponse response = await dataCatalogClient.UnstarEntryAsync(name);
UnstarEntryAsync(UnstarEntryRequest, CallSettings)
public virtual 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. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
UnstarEntryRequest request = new UnstarEntryRequest
{
EntryName = EntryName.FromProjectLocationEntryGroupEntry("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]"),
};
// Make the request
UnstarEntryResponse response = await dataCatalogClient.UnstarEntryAsync(request);
UnstarEntryAsync(UnstarEntryRequest, CancellationToken)
public virtual Task<UnstarEntryResponse> UnstarEntryAsync(UnstarEntryRequest request, CancellationToken cancellationToken)
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. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskUnstarEntryResponse | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
UnstarEntryRequest request = new UnstarEntryRequest
{
EntryName = EntryName.FromProjectLocationEntryGroupEntry("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]"),
};
// Make the request
UnstarEntryResponse response = await dataCatalogClient.UnstarEntryAsync(request);
UnstarEntryAsync(string, CallSettings)
public virtual Task<UnstarEntryResponse> UnstarEntryAsync(string name, 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 |
name | string Required. The name of the entry to mark as not starred. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskUnstarEntryResponse | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/entryGroups/[ENTRY_GROUP]/entries/[ENTRY]";
// Make the request
UnstarEntryResponse response = await dataCatalogClient.UnstarEntryAsync(name);
UnstarEntryAsync(string, CancellationToken)
public virtual Task<UnstarEntryResponse> UnstarEntryAsync(string name, CancellationToken cancellationToken)
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 |
name | string Required. The name of the entry to mark as not starred. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskUnstarEntryResponse | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/entryGroups/[ENTRY_GROUP]/entries/[ENTRY]";
// Make the request
UnstarEntryResponse response = await dataCatalogClient.UnstarEntryAsync(name);
UpdateEntry(Entry, CallSettings)
public virtual Entry UpdateEntry(Entry entry, 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 |
entry | Entry Required. Updates for the entry. The |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Entry | The RPC response. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
Entry entry = new Entry();
// Make the request
Entry response = dataCatalogClient.UpdateEntry(entry);
UpdateEntry(Entry, FieldMask, CallSettings)
public virtual Entry UpdateEntry(Entry entry, FieldMask updateMask, 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 |
entry | Entry Required. Updates for the entry. The |
updateMask | FieldMask Names of fields whose values to overwrite on an entry. If this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied. You can modify only the fields listed below. For entries with type
For entries with type
For entries with
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Entry | The RPC response. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
Entry entry = new Entry();
FieldMask updateMask = new FieldMask();
// Make the request
Entry response = dataCatalogClient.UpdateEntry(entry, updateMask);
UpdateEntry(UpdateEntryRequest, CallSettings)
public virtual 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. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
UpdateEntryRequest request = new UpdateEntryRequest
{
Entry = new Entry(),
UpdateMask = new FieldMask(),
};
// Make the request
Entry response = dataCatalogClient.UpdateEntry(request);
UpdateEntryAsync(Entry, CallSettings)
public virtual Task<Entry> UpdateEntryAsync(Entry entry, 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 |
entry | Entry Required. Updates for the entry. The |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskEntry | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
Entry entry = new Entry();
// Make the request
Entry response = await dataCatalogClient.UpdateEntryAsync(entry);
UpdateEntryAsync(Entry, FieldMask, CallSettings)
public virtual Task<Entry> UpdateEntryAsync(Entry entry, FieldMask updateMask, 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 |
entry | Entry Required. Updates for the entry. The |
updateMask | FieldMask Names of fields whose values to overwrite on an entry. If this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied. You can modify only the fields listed below. For entries with type
For entries with type
For entries with
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskEntry | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
Entry entry = new Entry();
FieldMask updateMask = new FieldMask();
// Make the request
Entry response = await dataCatalogClient.UpdateEntryAsync(entry, updateMask);
UpdateEntryAsync(Entry, FieldMask, CancellationToken)
public virtual Task<Entry> UpdateEntryAsync(Entry entry, FieldMask updateMask, CancellationToken cancellationToken)
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 |
entry | Entry Required. Updates for the entry. The |
updateMask | FieldMask Names of fields whose values to overwrite on an entry. If this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied. You can modify only the fields listed below. For entries with type
For entries with type
For entries with
|
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskEntry | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
Entry entry = new Entry();
FieldMask updateMask = new FieldMask();
// Make the request
Entry response = await dataCatalogClient.UpdateEntryAsync(entry, updateMask);
UpdateEntryAsync(Entry, CancellationToken)
public virtual Task<Entry> UpdateEntryAsync(Entry entry, CancellationToken cancellationToken)
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 |
entry | Entry Required. Updates for the entry. The |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskEntry | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
Entry entry = new Entry();
// Make the request
Entry response = await dataCatalogClient.UpdateEntryAsync(entry);
UpdateEntryAsync(UpdateEntryRequest, CallSettings)
public virtual 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. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
UpdateEntryRequest request = new UpdateEntryRequest
{
Entry = new Entry(),
UpdateMask = new FieldMask(),
};
// Make the request
Entry response = await dataCatalogClient.UpdateEntryAsync(request);
UpdateEntryAsync(UpdateEntryRequest, CancellationToken)
public virtual Task<Entry> UpdateEntryAsync(UpdateEntryRequest request, CancellationToken cancellationToken)
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. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskEntry | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
UpdateEntryRequest request = new UpdateEntryRequest
{
Entry = new Entry(),
UpdateMask = new FieldMask(),
};
// Make the request
Entry response = await dataCatalogClient.UpdateEntryAsync(request);
UpdateEntryGroup(EntryGroup, CallSettings)
public virtual EntryGroup UpdateEntryGroup(EntryGroup entryGroup, 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 |
entryGroup | EntryGroup Required. Updates for the entry group. The |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
EntryGroup | The RPC response. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
EntryGroup entryGroup = new EntryGroup();
// Make the request
EntryGroup response = dataCatalogClient.UpdateEntryGroup(entryGroup);
UpdateEntryGroup(EntryGroup, FieldMask, CallSettings)
public virtual EntryGroup UpdateEntryGroup(EntryGroup entryGroup, FieldMask updateMask, 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 |
entryGroup | EntryGroup Required. Updates for the entry group. The |
updateMask | FieldMask Names of fields whose values to overwrite on an entry group. If this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
EntryGroup | The RPC response. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
EntryGroup entryGroup = new EntryGroup();
FieldMask updateMask = new FieldMask();
// Make the request
EntryGroup response = dataCatalogClient.UpdateEntryGroup(entryGroup, updateMask);
UpdateEntryGroup(UpdateEntryGroupRequest, CallSettings)
public virtual 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. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
UpdateEntryGroupRequest request = new UpdateEntryGroupRequest
{
EntryGroup = new EntryGroup(),
UpdateMask = new FieldMask(),
};
// Make the request
EntryGroup response = dataCatalogClient.UpdateEntryGroup(request);
UpdateEntryGroupAsync(EntryGroup, CallSettings)
public virtual Task<EntryGroup> UpdateEntryGroupAsync(EntryGroup entryGroup, 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 |
entryGroup | EntryGroup Required. Updates for the entry group. The |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskEntryGroup | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
EntryGroup entryGroup = new EntryGroup();
// Make the request
EntryGroup response = await dataCatalogClient.UpdateEntryGroupAsync(entryGroup);
UpdateEntryGroupAsync(EntryGroup, FieldMask, CallSettings)
public virtual Task<EntryGroup> UpdateEntryGroupAsync(EntryGroup entryGroup, FieldMask updateMask, 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 |
entryGroup | EntryGroup Required. Updates for the entry group. The |
updateMask | FieldMask Names of fields whose values to overwrite on an entry group. If this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskEntryGroup | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
EntryGroup entryGroup = new EntryGroup();
FieldMask updateMask = new FieldMask();
// Make the request
EntryGroup response = await dataCatalogClient.UpdateEntryGroupAsync(entryGroup, updateMask);
UpdateEntryGroupAsync(EntryGroup, FieldMask, CancellationToken)
public virtual Task<EntryGroup> UpdateEntryGroupAsync(EntryGroup entryGroup, FieldMask updateMask, CancellationToken cancellationToken)
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 |
entryGroup | EntryGroup Required. Updates for the entry group. The |
updateMask | FieldMask Names of fields whose values to overwrite on an entry group. If this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskEntryGroup | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
EntryGroup entryGroup = new EntryGroup();
FieldMask updateMask = new FieldMask();
// Make the request
EntryGroup response = await dataCatalogClient.UpdateEntryGroupAsync(entryGroup, updateMask);
UpdateEntryGroupAsync(EntryGroup, CancellationToken)
public virtual Task<EntryGroup> UpdateEntryGroupAsync(EntryGroup entryGroup, CancellationToken cancellationToken)
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 |
entryGroup | EntryGroup Required. Updates for the entry group. The |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskEntryGroup | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
EntryGroup entryGroup = new EntryGroup();
// Make the request
EntryGroup response = await dataCatalogClient.UpdateEntryGroupAsync(entryGroup);
UpdateEntryGroupAsync(UpdateEntryGroupRequest, CallSettings)
public virtual 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. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
UpdateEntryGroupRequest request = new UpdateEntryGroupRequest
{
EntryGroup = new EntryGroup(),
UpdateMask = new FieldMask(),
};
// Make the request
EntryGroup response = await dataCatalogClient.UpdateEntryGroupAsync(request);
UpdateEntryGroupAsync(UpdateEntryGroupRequest, CancellationToken)
public virtual Task<EntryGroup> UpdateEntryGroupAsync(UpdateEntryGroupRequest request, CancellationToken cancellationToken)
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. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskEntryGroup | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
UpdateEntryGroupRequest request = new UpdateEntryGroupRequest
{
EntryGroup = new EntryGroup(),
UpdateMask = new FieldMask(),
};
// Make the request
EntryGroup response = await dataCatalogClient.UpdateEntryGroupAsync(request);
UpdateTag(Tag, CallSettings)
public virtual Tag UpdateTag(Tag tag, CallSettings callSettings = null)
Updates an existing tag.
Parameters | |
---|---|
Name | Description |
tag | Tag Required. The updated tag. The "name" field must be set. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Tag | The RPC response. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
Tag tag = new Tag();
// Make the request
Tag response = dataCatalogClient.UpdateTag(tag);
UpdateTag(Tag, FieldMask, CallSettings)
public virtual Tag UpdateTag(Tag tag, FieldMask updateMask, CallSettings callSettings = null)
Updates an existing tag.
Parameters | |
---|---|
Name | Description |
tag | Tag Required. The updated tag. The "name" field must be set. |
updateMask | FieldMask Names of fields whose values to overwrite on a tag. Currently, a tag has
the only modifiable field with the name In general, if this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Tag | The RPC response. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
Tag tag = new Tag();
FieldMask updateMask = new FieldMask();
// Make the request
Tag response = dataCatalogClient.UpdateTag(tag, updateMask);
UpdateTag(UpdateTagRequest, CallSettings)
public virtual 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. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
UpdateTagRequest request = new UpdateTagRequest
{
Tag = new Tag(),
UpdateMask = new FieldMask(),
};
// Make the request
Tag response = dataCatalogClient.UpdateTag(request);
UpdateTagAsync(Tag, CallSettings)
public virtual Task<Tag> UpdateTagAsync(Tag tag, CallSettings callSettings = null)
Updates an existing tag.
Parameters | |
---|---|
Name | Description |
tag | Tag Required. The updated tag. The "name" field must be set. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskTag | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
Tag tag = new Tag();
// Make the request
Tag response = await dataCatalogClient.UpdateTagAsync(tag);
UpdateTagAsync(Tag, FieldMask, CallSettings)
public virtual Task<Tag> UpdateTagAsync(Tag tag, FieldMask updateMask, CallSettings callSettings = null)
Updates an existing tag.
Parameters | |
---|---|
Name | Description |
tag | Tag Required. The updated tag. The "name" field must be set. |
updateMask | FieldMask Names of fields whose values to overwrite on a tag. Currently, a tag has
the only modifiable field with the name In general, if this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskTag | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
Tag tag = new Tag();
FieldMask updateMask = new FieldMask();
// Make the request
Tag response = await dataCatalogClient.UpdateTagAsync(tag, updateMask);
UpdateTagAsync(Tag, FieldMask, CancellationToken)
public virtual Task<Tag> UpdateTagAsync(Tag tag, FieldMask updateMask, CancellationToken cancellationToken)
Updates an existing tag.
Parameters | |
---|---|
Name | Description |
tag | Tag Required. The updated tag. The "name" field must be set. |
updateMask | FieldMask Names of fields whose values to overwrite on a tag. Currently, a tag has
the only modifiable field with the name In general, if this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskTag | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
Tag tag = new Tag();
FieldMask updateMask = new FieldMask();
// Make the request
Tag response = await dataCatalogClient.UpdateTagAsync(tag, updateMask);
UpdateTagAsync(Tag, CancellationToken)
public virtual Task<Tag> UpdateTagAsync(Tag tag, CancellationToken cancellationToken)
Updates an existing tag.
Parameters | |
---|---|
Name | Description |
tag | Tag Required. The updated tag. The "name" field must be set. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskTag | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
Tag tag = new Tag();
// Make the request
Tag response = await dataCatalogClient.UpdateTagAsync(tag);
UpdateTagAsync(UpdateTagRequest, CallSettings)
public virtual 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. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
UpdateTagRequest request = new UpdateTagRequest
{
Tag = new Tag(),
UpdateMask = new FieldMask(),
};
// Make the request
Tag response = await dataCatalogClient.UpdateTagAsync(request);
UpdateTagAsync(UpdateTagRequest, CancellationToken)
public virtual Task<Tag> UpdateTagAsync(UpdateTagRequest request, CancellationToken cancellationToken)
Updates an existing tag.
Parameters | |
---|---|
Name | Description |
request | UpdateTagRequest The request object containing all of the parameters for the API call. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskTag | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
UpdateTagRequest request = new UpdateTagRequest
{
Tag = new Tag(),
UpdateMask = new FieldMask(),
};
// Make the request
Tag response = await dataCatalogClient.UpdateTagAsync(request);
UpdateTagTemplate(TagTemplate, CallSettings)
public virtual TagTemplate UpdateTagTemplate(TagTemplate tagTemplate, 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 |
tagTemplate | TagTemplate Required. The template to update. The |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TagTemplate | The RPC response. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
TagTemplate tagTemplate = new TagTemplate();
// Make the request
TagTemplate response = dataCatalogClient.UpdateTagTemplate(tagTemplate);
UpdateTagTemplate(TagTemplate, FieldMask, CallSettings)
public virtual TagTemplate UpdateTagTemplate(TagTemplate tagTemplate, FieldMask updateMask, 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 |
tagTemplate | TagTemplate Required. The template to update. The |
updateMask | FieldMask Names of fields whose values to overwrite on a tag template. Currently,
only If this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied. Note: Updating the |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TagTemplate | The RPC response. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
TagTemplate tagTemplate = new TagTemplate();
FieldMask updateMask = new FieldMask();
// Make the request
TagTemplate response = dataCatalogClient.UpdateTagTemplate(tagTemplate, updateMask);
UpdateTagTemplate(UpdateTagTemplateRequest, CallSettings)
public virtual 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. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
UpdateTagTemplateRequest request = new UpdateTagTemplateRequest
{
TagTemplate = new TagTemplate(),
UpdateMask = new FieldMask(),
};
// Make the request
TagTemplate response = dataCatalogClient.UpdateTagTemplate(request);
UpdateTagTemplateAsync(TagTemplate, CallSettings)
public virtual Task<TagTemplate> UpdateTagTemplateAsync(TagTemplate tagTemplate, 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 |
tagTemplate | TagTemplate Required. The template to update. The |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskTagTemplate | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
TagTemplate tagTemplate = new TagTemplate();
// Make the request
TagTemplate response = await dataCatalogClient.UpdateTagTemplateAsync(tagTemplate);
UpdateTagTemplateAsync(TagTemplate, FieldMask, CallSettings)
public virtual Task<TagTemplate> UpdateTagTemplateAsync(TagTemplate tagTemplate, FieldMask updateMask, 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 |
tagTemplate | TagTemplate Required. The template to update. The |
updateMask | FieldMask Names of fields whose values to overwrite on a tag template. Currently,
only If this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied. Note: Updating the |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskTagTemplate | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
TagTemplate tagTemplate = new TagTemplate();
FieldMask updateMask = new FieldMask();
// Make the request
TagTemplate response = await dataCatalogClient.UpdateTagTemplateAsync(tagTemplate, updateMask);
UpdateTagTemplateAsync(TagTemplate, FieldMask, CancellationToken)
public virtual Task<TagTemplate> UpdateTagTemplateAsync(TagTemplate tagTemplate, FieldMask updateMask, CancellationToken cancellationToken)
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 |
tagTemplate | TagTemplate Required. The template to update. The |
updateMask | FieldMask Names of fields whose values to overwrite on a tag template. Currently,
only If this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied. Note: Updating the |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskTagTemplate | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
TagTemplate tagTemplate = new TagTemplate();
FieldMask updateMask = new FieldMask();
// Make the request
TagTemplate response = await dataCatalogClient.UpdateTagTemplateAsync(tagTemplate, updateMask);
UpdateTagTemplateAsync(TagTemplate, CancellationToken)
public virtual Task<TagTemplate> UpdateTagTemplateAsync(TagTemplate tagTemplate, CancellationToken cancellationToken)
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 |
tagTemplate | TagTemplate Required. The template to update. The |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskTagTemplate | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
TagTemplate tagTemplate = new TagTemplate();
// Make the request
TagTemplate response = await dataCatalogClient.UpdateTagTemplateAsync(tagTemplate);
UpdateTagTemplateAsync(UpdateTagTemplateRequest, CallSettings)
public virtual 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. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
UpdateTagTemplateRequest request = new UpdateTagTemplateRequest
{
TagTemplate = new TagTemplate(),
UpdateMask = new FieldMask(),
};
// Make the request
TagTemplate response = await dataCatalogClient.UpdateTagTemplateAsync(request);
UpdateTagTemplateAsync(UpdateTagTemplateRequest, CancellationToken)
public virtual Task<TagTemplate> UpdateTagTemplateAsync(UpdateTagTemplateRequest request, CancellationToken cancellationToken)
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. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskTagTemplate | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
UpdateTagTemplateRequest request = new UpdateTagTemplateRequest
{
TagTemplate = new TagTemplate(),
UpdateMask = new FieldMask(),
};
// Make the request
TagTemplate response = await dataCatalogClient.UpdateTagTemplateAsync(request);
UpdateTagTemplateField(TagTemplateFieldName, TagTemplateField, CallSettings)
public virtual TagTemplateField UpdateTagTemplateField(TagTemplateFieldName name, TagTemplateField tagTemplateField, 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 |
name | TagTemplateFieldName Required. The name of the tag template field. |
tagTemplateField | TagTemplateField Required. The template to update. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TagTemplateField | The RPC response. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
TagTemplateFieldName name = TagTemplateFieldName.FromProjectLocationTagTemplateField("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]");
TagTemplateField tagTemplateField = new TagTemplateField();
// Make the request
TagTemplateField response = dataCatalogClient.UpdateTagTemplateField(name, tagTemplateField);
UpdateTagTemplateField(TagTemplateFieldName, TagTemplateField, FieldMask, CallSettings)
public virtual TagTemplateField UpdateTagTemplateField(TagTemplateFieldName name, TagTemplateField tagTemplateField, FieldMask updateMask, 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 |
name | TagTemplateFieldName Required. The name of the tag template field. |
tagTemplateField | TagTemplateField Required. The template to update. |
updateMask | FieldMask Optional. Names of fields whose values to overwrite on an individual field of a tag template. The following fields are modifiable:
If this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied with one exception: when updating an enum type, the provided values are merged with the existing values. Therefore, enum values can only be added, existing enum values cannot be deleted or renamed. Additionally, updating a template field from optional to required is not allowed. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TagTemplateField | The RPC response. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
TagTemplateFieldName name = TagTemplateFieldName.FromProjectLocationTagTemplateField("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]");
TagTemplateField tagTemplateField = new TagTemplateField();
FieldMask updateMask = new FieldMask();
// Make the request
TagTemplateField response = dataCatalogClient.UpdateTagTemplateField(name, tagTemplateField, updateMask);
UpdateTagTemplateField(UpdateTagTemplateFieldRequest, CallSettings)
public virtual 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. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
UpdateTagTemplateFieldRequest request = new UpdateTagTemplateFieldRequest
{
TagTemplateFieldName = TagTemplateFieldName.FromProjectLocationTagTemplateField("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]"),
TagTemplateField = new TagTemplateField(),
UpdateMask = new FieldMask(),
};
// Make the request
TagTemplateField response = dataCatalogClient.UpdateTagTemplateField(request);
UpdateTagTemplateField(string, TagTemplateField, CallSettings)
public virtual TagTemplateField UpdateTagTemplateField(string name, TagTemplateField tagTemplateField, 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 |
name | string Required. The name of the tag template field. |
tagTemplateField | TagTemplateField Required. The template to update. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TagTemplateField | The RPC response. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/tagTemplates/[TAG_TEMPLATE]/fields/[FIELD]";
TagTemplateField tagTemplateField = new TagTemplateField();
// Make the request
TagTemplateField response = dataCatalogClient.UpdateTagTemplateField(name, tagTemplateField);
UpdateTagTemplateField(string, TagTemplateField, FieldMask, CallSettings)
public virtual TagTemplateField UpdateTagTemplateField(string name, TagTemplateField tagTemplateField, FieldMask updateMask, 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 |
name | string Required. The name of the tag template field. |
tagTemplateField | TagTemplateField Required. The template to update. |
updateMask | FieldMask Optional. Names of fields whose values to overwrite on an individual field of a tag template. The following fields are modifiable:
If this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied with one exception: when updating an enum type, the provided values are merged with the existing values. Therefore, enum values can only be added, existing enum values cannot be deleted or renamed. Additionally, updating a template field from optional to required is not allowed. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TagTemplateField | The RPC response. |
// Create client
DataCatalogClient dataCatalogClient = DataCatalogClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/tagTemplates/[TAG_TEMPLATE]/fields/[FIELD]";
TagTemplateField tagTemplateField = new TagTemplateField();
FieldMask updateMask = new FieldMask();
// Make the request
TagTemplateField response = dataCatalogClient.UpdateTagTemplateField(name, tagTemplateField, updateMask);
UpdateTagTemplateFieldAsync(TagTemplateFieldName, TagTemplateField, CallSettings)
public virtual Task<TagTemplateField> UpdateTagTemplateFieldAsync(TagTemplateFieldName name, TagTemplateField tagTemplateField, 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 |
name | TagTemplateFieldName Required. The name of the tag template field. |
tagTemplateField | TagTemplateField Required. The template to update. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskTagTemplateField | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
TagTemplateFieldName name = TagTemplateFieldName.FromProjectLocationTagTemplateField("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]");
TagTemplateField tagTemplateField = new TagTemplateField();
// Make the request
TagTemplateField response = await dataCatalogClient.UpdateTagTemplateFieldAsync(name, tagTemplateField);
UpdateTagTemplateFieldAsync(TagTemplateFieldName, TagTemplateField, FieldMask, CallSettings)
public virtual Task<TagTemplateField> UpdateTagTemplateFieldAsync(TagTemplateFieldName name, TagTemplateField tagTemplateField, FieldMask updateMask, 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 |
name | TagTemplateFieldName Required. The name of the tag template field. |
tagTemplateField | TagTemplateField Required. The template to update. |
updateMask | FieldMask Optional. Names of fields whose values to overwrite on an individual field of a tag template. The following fields are modifiable:
If this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied with one exception: when updating an enum type, the provided values are merged with the existing values. Therefore, enum values can only be added, existing enum values cannot be deleted or renamed. Additionally, updating a template field from optional to required is not allowed. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskTagTemplateField | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
TagTemplateFieldName name = TagTemplateFieldName.FromProjectLocationTagTemplateField("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]");
TagTemplateField tagTemplateField = new TagTemplateField();
FieldMask updateMask = new FieldMask();
// Make the request
TagTemplateField response = await dataCatalogClient.UpdateTagTemplateFieldAsync(name, tagTemplateField, updateMask);
UpdateTagTemplateFieldAsync(TagTemplateFieldName, TagTemplateField, FieldMask, CancellationToken)
public virtual Task<TagTemplateField> UpdateTagTemplateFieldAsync(TagTemplateFieldName name, TagTemplateField tagTemplateField, FieldMask updateMask, CancellationToken cancellationToken)
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 |
name | TagTemplateFieldName Required. The name of the tag template field. |
tagTemplateField | TagTemplateField Required. The template to update. |
updateMask | FieldMask Optional. Names of fields whose values to overwrite on an individual field of a tag template. The following fields are modifiable:
If this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied with one exception: when updating an enum type, the provided values are merged with the existing values. Therefore, enum values can only be added, existing enum values cannot be deleted or renamed. Additionally, updating a template field from optional to required is not allowed. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskTagTemplateField | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
TagTemplateFieldName name = TagTemplateFieldName.FromProjectLocationTagTemplateField("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]");
TagTemplateField tagTemplateField = new TagTemplateField();
FieldMask updateMask = new FieldMask();
// Make the request
TagTemplateField response = await dataCatalogClient.UpdateTagTemplateFieldAsync(name, tagTemplateField, updateMask);
UpdateTagTemplateFieldAsync(TagTemplateFieldName, TagTemplateField, CancellationToken)
public virtual Task<TagTemplateField> UpdateTagTemplateFieldAsync(TagTemplateFieldName name, TagTemplateField tagTemplateField, CancellationToken cancellationToken)
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 |
name | TagTemplateFieldName Required. The name of the tag template field. |
tagTemplateField | TagTemplateField Required. The template to update. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskTagTemplateField | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
TagTemplateFieldName name = TagTemplateFieldName.FromProjectLocationTagTemplateField("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]");
TagTemplateField tagTemplateField = new TagTemplateField();
// Make the request
TagTemplateField response = await dataCatalogClient.UpdateTagTemplateFieldAsync(name, tagTemplateField);
UpdateTagTemplateFieldAsync(UpdateTagTemplateFieldRequest, CallSettings)
public virtual 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. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
UpdateTagTemplateFieldRequest request = new UpdateTagTemplateFieldRequest
{
TagTemplateFieldName = TagTemplateFieldName.FromProjectLocationTagTemplateField("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]"),
TagTemplateField = new TagTemplateField(),
UpdateMask = new FieldMask(),
};
// Make the request
TagTemplateField response = await dataCatalogClient.UpdateTagTemplateFieldAsync(request);
UpdateTagTemplateFieldAsync(UpdateTagTemplateFieldRequest, CancellationToken)
public virtual Task<TagTemplateField> UpdateTagTemplateFieldAsync(UpdateTagTemplateFieldRequest request, CancellationToken cancellationToken)
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. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskTagTemplateField | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
UpdateTagTemplateFieldRequest request = new UpdateTagTemplateFieldRequest
{
TagTemplateFieldName = TagTemplateFieldName.FromProjectLocationTagTemplateField("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]"),
TagTemplateField = new TagTemplateField(),
UpdateMask = new FieldMask(),
};
// Make the request
TagTemplateField response = await dataCatalogClient.UpdateTagTemplateFieldAsync(request);
UpdateTagTemplateFieldAsync(string, TagTemplateField, CallSettings)
public virtual Task<TagTemplateField> UpdateTagTemplateFieldAsync(string name, TagTemplateField tagTemplateField, 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 |
name | string Required. The name of the tag template field. |
tagTemplateField | TagTemplateField Required. The template to update. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskTagTemplateField | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/tagTemplates/[TAG_TEMPLATE]/fields/[FIELD]";
TagTemplateField tagTemplateField = new TagTemplateField();
// Make the request
TagTemplateField response = await dataCatalogClient.UpdateTagTemplateFieldAsync(name, tagTemplateField);
UpdateTagTemplateFieldAsync(string, TagTemplateField, FieldMask, CallSettings)
public virtual Task<TagTemplateField> UpdateTagTemplateFieldAsync(string name, TagTemplateField tagTemplateField, FieldMask updateMask, 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 |
name | string Required. The name of the tag template field. |
tagTemplateField | TagTemplateField Required. The template to update. |
updateMask | FieldMask Optional. Names of fields whose values to overwrite on an individual field of a tag template. The following fields are modifiable:
If this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied with one exception: when updating an enum type, the provided values are merged with the existing values. Therefore, enum values can only be added, existing enum values cannot be deleted or renamed. Additionally, updating a template field from optional to required is not allowed. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskTagTemplateField | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/tagTemplates/[TAG_TEMPLATE]/fields/[FIELD]";
TagTemplateField tagTemplateField = new TagTemplateField();
FieldMask updateMask = new FieldMask();
// Make the request
TagTemplateField response = await dataCatalogClient.UpdateTagTemplateFieldAsync(name, tagTemplateField, updateMask);
UpdateTagTemplateFieldAsync(string, TagTemplateField, FieldMask, CancellationToken)
public virtual Task<TagTemplateField> UpdateTagTemplateFieldAsync(string name, TagTemplateField tagTemplateField, FieldMask updateMask, CancellationToken cancellationToken)
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 |
name | string Required. The name of the tag template field. |
tagTemplateField | TagTemplateField Required. The template to update. |
updateMask | FieldMask Optional. Names of fields whose values to overwrite on an individual field of a tag template. The following fields are modifiable:
If this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied with one exception: when updating an enum type, the provided values are merged with the existing values. Therefore, enum values can only be added, existing enum values cannot be deleted or renamed. Additionally, updating a template field from optional to required is not allowed. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskTagTemplateField | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/tagTemplates/[TAG_TEMPLATE]/fields/[FIELD]";
TagTemplateField tagTemplateField = new TagTemplateField();
FieldMask updateMask = new FieldMask();
// Make the request
TagTemplateField response = await dataCatalogClient.UpdateTagTemplateFieldAsync(name, tagTemplateField, updateMask);
UpdateTagTemplateFieldAsync(string, TagTemplateField, CancellationToken)
public virtual Task<TagTemplateField> UpdateTagTemplateFieldAsync(string name, TagTemplateField tagTemplateField, CancellationToken cancellationToken)
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 |
name | string Required. The name of the tag template field. |
tagTemplateField | TagTemplateField Required. The template to update. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskTagTemplateField | A Task containing the RPC response. |
// Create client
DataCatalogClient dataCatalogClient = await DataCatalogClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/tagTemplates/[TAG_TEMPLATE]/fields/[FIELD]";
TagTemplateField tagTemplateField = new TagTemplateField();
// Make the request
TagTemplateField response = await dataCatalogClient.UpdateTagTemplateFieldAsync(name, tagTemplateField);