Namespace Google.Apis.DataCatalog.v1

Classes

Searches Data Catalog for multiple resources like entries and tags that match a query. This is a [Custom Method] (https://cloud.google.com/apis/design/custom_methods) 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] (https://cloud.google.com/data-catalog/docs/how-to/search-reference).

DataCatalogBaseServiceRequest<TResponse>

A base abstract class for DataCatalog requests.

DataCatalogService

The DataCatalog Service.

DataCatalogService.Scope

Available OAuth 2.0 scopes for use with the Google Cloud Data Catalog API.

DataCatalogService.ScopeConstants

Available OAuth 2.0 scope constants for use with the Google Cloud Data Catalog API.

EntriesResource

The "entries" collection of methods.

EntriesResource.LookupRequest

Gets an entry by its target resource name. The resource name comes from the source Google Cloud Platform service.

OrganizationsResource

The "organizations" collection of methods.

OrganizationsResource.LocationsResource

The "locations" collection of methods.

OrganizationsResource.LocationsResource.RetrieveConfigRequest

Retrieves the configuration related to the migration from Data Catalog to Dataplex for a specific organization, including all the projects under it which have a separate configuration set.

OrganizationsResource.LocationsResource.RetrieveEffectiveConfigRequest

Retrieves the effective configuration related to the migration from Data Catalog to Dataplex for a specific organization or project. If there is no specific configuration set for the resource, the setting is checked hierarchicahlly through the ancestors of the resource, starting from the resource itself.

OrganizationsResource.LocationsResource.SetConfigRequest

Sets the configuration related to the migration to Dataplex for an organization or project.

ProjectsResource

The "projects" collection of methods.

ProjectsResource.LocationsResource

The "locations" collection of methods.

ProjectsResource.LocationsResource.EntryGroupsResource

The "entryGroups" collection of methods.

ProjectsResource.LocationsResource.EntryGroupsResource.CreateRequest

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.

ProjectsResource.LocationsResource.EntryGroupsResource.DeleteRequest

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.

ProjectsResource.LocationsResource.EntryGroupsResource.EntriesResource

The "entries" collection of methods.

ProjectsResource.LocationsResource.EntryGroupsResource.EntriesResource.CreateRequest

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.

ProjectsResource.LocationsResource.EntryGroupsResource.EntriesResource.DeleteRequest

Deletes an existing entry. You can delete only the entries created by the 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.

ProjectsResource.LocationsResource.EntryGroupsResource.EntriesResource.GetIamPolicyRequest

Gets the access control policy for a resource. May return: * ANOT_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.

ProjectsResource.LocationsResource.EntryGroupsResource.EntriesResource.GetRequest

Gets an entry.

ProjectsResource.LocationsResource.EntryGroupsResource.EntriesResource.ImportRequest

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 type. ImportEntries returns a long-running operation resource that can be queried with Operations.GetOperation to return ImportEntriesMetadata and an ImportEntriesResponse message.

ProjectsResource.LocationsResource.EntryGroupsResource.EntriesResource.ListRequest

Lists entries. Note: Currently, this method can list only custom entries. To get a list of both custom and automatically created entries, use SearchCatalog.

ProjectsResource.LocationsResource.EntryGroupsResource.EntriesResource.ModifyEntryContactsRequest

Modifies contacts, part of the business context of an Entry. To call this method, you must have the datacatalog.entries.updateContacts IAM permission on the corresponding project.

ProjectsResource.LocationsResource.EntryGroupsResource.EntriesResource.ModifyEntryOverviewRequest

Modifies entry overview, part of the business context of an Entry. To call this method, you must have the datacatalog.entries.updateOverview IAM permission on the corresponding project.

ProjectsResource.LocationsResource.EntryGroupsResource.EntriesResource.PatchRequest

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.

ProjectsResource.LocationsResource.EntryGroupsResource.EntriesResource.StarRequest

Marks an Entry as starred by the current user. Starring information is private to each user.

ProjectsResource.LocationsResource.EntryGroupsResource.EntriesResource.TagsResource

The "tags" collection of methods.

ProjectsResource.LocationsResource.EntryGroupsResource.EntriesResource.TagsResource.CreateRequest

Creates a tag and assigns it to: * An Entry if the method name is projects.locations.entryGroups.entries.tags.create. * Or EntryGroupif the method name is projects.locations.entryGroups.tags.create. Note: The project identified by the parent parameter for the [tag] (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries.tags/create#path-parameters) and the [tag template] (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.tagTemplates/create#path-parameters) used to create the tag must be in the same organization.

ProjectsResource.LocationsResource.EntryGroupsResource.EntriesResource.TagsResource.DeleteRequest

Deletes a tag.

ProjectsResource.LocationsResource.EntryGroupsResource.EntriesResource.TagsResource.ListRequest

Lists tags assigned to an Entry. The columns in the response are lowercased.

ProjectsResource.LocationsResource.EntryGroupsResource.EntriesResource.TagsResource.PatchRequest

Updates an existing tag.

ProjectsResource.LocationsResource.EntryGroupsResource.EntriesResource.TagsResource.ReconcileRequest

ReconcileTags creates or updates a list of tags on the entry. If the ReconcileTagsRequest.force_delete_missing parameter is set, the operation deletes tags not included in the input tag list. ReconcileTags returns a long-running operation resource that can be queried with Operations.GetOperation to return ReconcileTagsMetadata and a ReconcileTagsResponse message.

ProjectsResource.LocationsResource.EntryGroupsResource.EntriesResource.TestIamPermissionsRequest

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.

ProjectsResource.LocationsResource.EntryGroupsResource.EntriesResource.UnstarRequest

Marks an Entry as NOT starred by the current user. Starring information is private to each user.

ProjectsResource.LocationsResource.EntryGroupsResource.GetIamPolicyRequest

ProjectsResource.LocationsResource.EntryGroupsResource.GetRequest

Gets an entry group.

ProjectsResource.LocationsResource.EntryGroupsResource.ListRequest

Lists entry groups.

ProjectsResource.LocationsResource.EntryGroupsResource.PatchRequest

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.

ProjectsResource.LocationsResource.EntryGroupsResource.SetIamPolicyRequest

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.

ProjectsResource.LocationsResource.EntryGroupsResource.TagsResource

The "tags" collection of methods.

ProjectsResource.LocationsResource.EntryGroupsResource.TagsResource.CreateRequest

ProjectsResource.LocationsResource.EntryGroupsResource.TagsResource.DeleteRequest

Deletes a tag.

ProjectsResource.LocationsResource.EntryGroupsResource.TagsResource.ListRequest

Lists tags assigned to an Entry. The columns in the response are lowercased.

ProjectsResource.LocationsResource.EntryGroupsResource.TagsResource.PatchRequest

Updates an existing tag.

ProjectsResource.LocationsResource.EntryGroupsResource.TestIamPermissionsRequest

ProjectsResource.LocationsResource.OperationsResource

The "operations" collection of methods.

ProjectsResource.LocationsResource.OperationsResource.CancelRequest

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

ProjectsResource.LocationsResource.OperationsResource.DeleteRequest

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

ProjectsResource.LocationsResource.OperationsResource.GetRequest

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

ProjectsResource.LocationsResource.OperationsResource.ListRequest

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

ProjectsResource.LocationsResource.RetrieveEffectiveConfigRequest

ProjectsResource.LocationsResource.SetConfigRequest

Sets the configuration related to the migration to Dataplex for an organization or project.

ProjectsResource.LocationsResource.TagTemplatesResource

The "tagTemplates" collection of methods.

ProjectsResource.LocationsResource.TagTemplatesResource.CreateRequest

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] (https://cloud.google.com/data-catalog/docs/concepts/resource-project).

ProjectsResource.LocationsResource.TagTemplatesResource.DeleteRequest

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.

ProjectsResource.LocationsResource.TagTemplatesResource.FieldsResource

The "fields" collection of methods.

ProjectsResource.LocationsResource.TagTemplatesResource.FieldsResource.CreateRequest

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.

ProjectsResource.LocationsResource.TagTemplatesResource.FieldsResource.DeleteRequest

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.

ProjectsResource.LocationsResource.TagTemplatesResource.FieldsResource.EnumValuesResource

The "enumValues" collection of methods.

ProjectsResource.LocationsResource.TagTemplatesResource.FieldsResource.EnumValuesResource.RenameRequest

Renames an enum value in a tag template. Within a single enum field, enum values must be unique.

ProjectsResource.LocationsResource.TagTemplatesResource.FieldsResource.PatchRequest

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.

ProjectsResource.LocationsResource.TagTemplatesResource.FieldsResource.RenameRequest

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] (https://cloud.google.com/data-catalog/docs/concepts/resource-project).

ProjectsResource.LocationsResource.TagTemplatesResource.GetIamPolicyRequest

ProjectsResource.LocationsResource.TagTemplatesResource.GetRequest

Gets a tag template.

ProjectsResource.LocationsResource.TagTemplatesResource.PatchRequest

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.

ProjectsResource.LocationsResource.TagTemplatesResource.SetIamPolicyRequest

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.

ProjectsResource.LocationsResource.TagTemplatesResource.TestIamPermissionsRequest

ProjectsResource.LocationsResource.TaxonomiesResource

The "taxonomies" collection of methods.

ProjectsResource.LocationsResource.TaxonomiesResource.CreateRequest

Creates a taxonomy in a specified project. The taxonomy is initially empty, that is, it doesn't contain policy tags.

ProjectsResource.LocationsResource.TaxonomiesResource.DeleteRequest

Deletes a taxonomy, including all policy tags in this taxonomy, their associated policies, and the policy tags references from BigQuery columns.

ProjectsResource.LocationsResource.TaxonomiesResource.ExportRequest

Exports taxonomies in the requested type and returns them, including their policy tags. The requested taxonomies must belong to the same project. This method generates SerializedTaxonomy protocol buffers with nested policy tags that can be used as input for ImportTaxonomies calls.

ProjectsResource.LocationsResource.TaxonomiesResource.GetIamPolicyRequest

Gets the IAM policy for a policy tag or a taxonomy.

ProjectsResource.LocationsResource.TaxonomiesResource.GetRequest

Gets a taxonomy.

ProjectsResource.LocationsResource.TaxonomiesResource.ImportRequest

Creates new taxonomies (including their policy tags) in a given project by importing from inlined or cross-regional sources. For a cross-regional source, new taxonomies are created by copying from a source in another region. For an inlined source, taxonomies and policy tags are created in bulk using nested protocol buffer structures.

ProjectsResource.LocationsResource.TaxonomiesResource.ListRequest

Lists all taxonomies in a project in a particular location that you have a permission to view.

ProjectsResource.LocationsResource.TaxonomiesResource.PatchRequest

Updates a taxonomy, including its display name, description, and activated policy types.

ProjectsResource.LocationsResource.TaxonomiesResource.PolicyTagsResource

The "policyTags" collection of methods.

ProjectsResource.LocationsResource.TaxonomiesResource.PolicyTagsResource.CreateRequest

Creates a policy tag in a taxonomy.

ProjectsResource.LocationsResource.TaxonomiesResource.PolicyTagsResource.DeleteRequest

Deletes a policy tag together with the following: * All of its descendant policy tags, if any * Policies associated with the policy tag and its descendants * References from BigQuery table schema of the policy tag and its descendants

ProjectsResource.LocationsResource.TaxonomiesResource.PolicyTagsResource.GetIamPolicyRequest

Gets the IAM policy for a policy tag or a taxonomy.

ProjectsResource.LocationsResource.TaxonomiesResource.PolicyTagsResource.GetRequest

Gets a policy tag.

ProjectsResource.LocationsResource.TaxonomiesResource.PolicyTagsResource.ListRequest

Lists all policy tags in a taxonomy.

ProjectsResource.LocationsResource.TaxonomiesResource.PolicyTagsResource.PatchRequest

Updates a policy tag, including its display name, description, and parent policy tag.

ProjectsResource.LocationsResource.TaxonomiesResource.PolicyTagsResource.SetIamPolicyRequest

Sets the IAM policy for a policy tag or a taxonomy.

ProjectsResource.LocationsResource.TaxonomiesResource.PolicyTagsResource.TestIamPermissionsRequest

Returns your permissions on a specified policy tag or taxonomy.

ProjectsResource.LocationsResource.TaxonomiesResource.ReplaceRequest

Replaces (updates) a taxonomy and all its policy tags. The taxonomy and its entire hierarchy of policy tags must be represented literally by SerializedTaxonomy and the nested SerializedPolicyTag messages. This operation automatically does the following: - Deletes the existing policy tags that are missing from the SerializedPolicyTag. - Creates policy tags that don't have resource names. They are considered new. - Updates policy tags with valid resources names accordingly.

ProjectsResource.LocationsResource.TaxonomiesResource.SetIamPolicyRequest

Sets the IAM policy for a policy tag or a taxonomy.

ProjectsResource.LocationsResource.TaxonomiesResource.TestIamPermissionsRequest

Returns your permissions on a specified policy tag or taxonomy.

Enums

DataCatalogBaseServiceRequest<TResponse>.AltEnum

Data format for response.

DataCatalogBaseServiceRequest<TResponse>.XgafvEnum

V1 error format.