Class DataCatalogAsyncClient (2.0.2)

DataCatalogAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.datacatalog_v1.services.data_catalog.transports.base.DataCatalogTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/python-datacatalog/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = None)

Data Catalog API service allows clients to discover, understand, and manage their data.

Methods

DataCatalogAsyncClient

DataCatalogAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.datacatalog_v1.services.data_catalog.transports.base.DataCatalogTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/python-datacatalog/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = None)

Instantiate the data catalog client.

Parameters
NameDescription
credentials Optional[google.auth.credentials.Credentials]

The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.

transport Union[str, .DataCatalogTransport]

The transport to use. If set to None, a transport is chosen automatically.

client_options ClientOptions

Custom options for the client. It won't take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint, this is the default value for the environment variable) and "auto" (auto switch to the default mTLS endpoint if client SSL credentials is present). However, the api_endpoint property takes precedence if provided. (2) The client_cert_source property is used to provide client SSL credentials for mutual TLS transport. If not provided, the default SSL credentials will be used if present.

Exceptions
TypeDescription
google.auth.exceptions.MutualTlsChannelErrorIf mutual TLS transport creation failed for any reason.

create_entry

create_entry(request: Optional[google.cloud.datacatalog_v1.types.datacatalog.CreateEntryRequest] = None, *, parent: Optional[str] = None, entry_id: Optional[str] = None, entry: Optional[google.cloud.datacatalog_v1.types.datacatalog.Entry] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates an entry. Only entries of 'FILESET' type or user-specified type can be created.

Users should enable the Data Catalog API in the project identified by the parent parameter (see Data Catalog Resource Project for more information).

A maximum of 100,000 entries may be created per entry group.

Parameters
NameDescription
request .datacatalog.CreateEntryRequest

The request object. Request message for CreateEntry.

parent str

Required. The name of the entry group this entry is in. Example: - projects/{project_id}/locations/{location}/entryGroups/{entry_group_id} Note that this Entry and its child resources may not actually be stored in the location in this name. This corresponds to the parent field on the request instance; if request is provided, this should not be set.

entry_id str

Required. The id of the entry to create. This corresponds to the entry_id field on the request instance; if request is provided, this should not be set.

entry .datacatalog.Entry

Required. The entry to create. This corresponds to the entry field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
.datacatalog.EntryEntry Metadata. A Data Catalog Entry resource represents another resource in Google Cloud Platform (such as a BigQuery dataset or a Pub/Sub topic) or outside of Google Cloud Platform. Clients can use the linked_resource field in the Entry resource to refer to the original resource ID of the source system. An Entry resource contains resource details, such as its schema. An Entry can also be used to attach flexible metadata, such as a Tag.

create_entry_group

create_entry_group(request: Optional[google.cloud.datacatalog_v1.types.datacatalog.CreateEntryGroupRequest] = None, *, parent: Optional[str] = None, entry_group_id: Optional[str] = None, entry_group: Optional[google.cloud.datacatalog_v1.types.datacatalog.EntryGroup] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates an EntryGroup.

An entry group contains logically related entries together with Cloud Identity and Access Management policies that specify the users who can create, edit, and view entries within the entry group.

Data Catalog automatically creates an entry group for BigQuery entries ("@bigquery") and Pub/Sub topics ("@pubsub"). Users create their own entry group to contain Cloud Storage fileset entries or custom type entries, and the IAM policies associated with those entries. Entry groups, like entries, can be searched.

A maximum of 10,000 entry groups may be created per organization across all locations.

Users should enable the Data Catalog API in the project identified by the parent parameter (see Data Catalog Resource Project for more information).

Parameters
NameDescription
request .datacatalog.CreateEntryGroupRequest

The request object. Request message for CreateEntryGroup.

parent str

Required. The name of the project this entry group is in. Example: - projects/{project_id}/locations/{location} Note that this EntryGroup and its child resources may not actually be stored in the location in this name. This corresponds to the parent field on the request instance; if request is provided, this should not be set.

entry_group_id str

Required. The id of the entry group to create. The id must begin with a letter or underscore, contain only English letters, numbers and underscores, and be at most 64 characters. This corresponds to the entry_group_id field on the request instance; if request is provided, this should not be set.

entry_group .datacatalog.EntryGroup

The entry group to create. Defaults to an empty entry group. This corresponds to the entry_group field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
.datacatalog.EntryGroupEntryGroup Metadata. An EntryGroup resource represents a logical grouping of zero or more Data Catalog Entry resources.

create_tag

create_tag(request: Optional[google.cloud.datacatalog_v1.types.datacatalog.CreateTagRequest] = None, *, parent: Optional[str] = None, tag: Optional[google.cloud.datacatalog_v1.types.tags.Tag] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a tag on an xref_Entry. 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 from the same organization.

Parameters
NameDescription
request .datacatalog.CreateTagRequest

The request object. Request message for CreateTag.

parent str

Required. The name of the resource to attach this tag to. Tags can be attached to Entries. Example: - projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id} Note that this Tag and its child resources may not actually be stored in the location in this name. This corresponds to the parent field on the request instance; if request is provided, this should not be set.

tag .tags.Tag

Required. The tag to create. This corresponds to the tag field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
.tags.TagTags are used to attach custom metadata to Data Catalog resources. Tags conform to the specifications within their tag template. See Data Catalog IAM __ for information on the permissions needed to create or view tags.

create_tag_template

create_tag_template(request: Optional[google.cloud.datacatalog_v1.types.datacatalog.CreateTagTemplateRequest] = None, *, parent: Optional[str] = None, tag_template_id: Optional[str] = None, tag_template: Optional[google.cloud.datacatalog_v1.types.tags.TagTemplate] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a tag template. The user should enable the Data Catalog API in the project identified by the parent parameter (see Data Catalog Resource Project <https://cloud.google.com/data-catalog/docs/concepts/resource-project>__ for more information).

Parameters
NameDescription
request .datacatalog.CreateTagTemplateRequest

The request object. Request message for CreateTagTemplate.

parent str

Required. The name of the project and the template location region https://cloud.google.com/data-catalog/docs/concepts/regions__. Example: - projects/{project_id}/locations/us-central1 This corresponds to the parent field on the request instance; if request is provided, this should not be set.

tag_template_id str

Required. The id of the tag template to create. This corresponds to the tag_template_id field on the request instance; if request is provided, this should not be set.

tag_template .tags.TagTemplate

Required. The tag template to create. This corresponds to the tag_template field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
.tags.TagTemplateA tag template defines a tag, which can have one or more typed fields. The template is used to create and attach the tag to GCP resources. Tag template roles __ provide permissions to create, edit, and use the template. See, for example, the TagTemplate User __ role, which includes permission to use the tag template to tag resources.

create_tag_template_field

create_tag_template_field(request: Optional[google.cloud.datacatalog_v1.types.datacatalog.CreateTagTemplateFieldRequest] = None, *, parent: Optional[str] = None, tag_template_field_id: Optional[str] = None, tag_template_field: Optional[google.cloud.datacatalog_v1.types.tags.TagTemplateField] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a field in a tag template. The user should enable the Data Catalog API in the project identified by the parent parameter (see Data Catalog Resource Project <https://cloud.google.com/data-catalog/docs/concepts/resource-project>__ for more information).

Parameters
NameDescription
request .datacatalog.CreateTagTemplateFieldRequest

The request object. Request message for CreateTagTemplateField.

parent str

Required. The name of the project and the template location region https://cloud.google.com/data-catalog/docs/concepts/regions__. Example: - projects/{project_id}/locations/us-central1/tagTemplates/{tag_template_id} This corresponds to the parent field on the request instance; if request is provided, this should not be set.

tag_template_field_id str

Required. The ID of the tag template field to create. 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. This corresponds to the tag_template_field_id field on the request instance; if request is provided, this should not be set.

tag_template_field .tags.TagTemplateField

Required. The tag template field to create. This corresponds to the tag_template_field field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
.tags.TagTemplateFieldThe template for an individual field within a tag template.

delete_entry

delete_entry(request: Optional[google.cloud.datacatalog_v1.types.datacatalog.DeleteEntryRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes an existing entry. Only entries created through xref_CreateEntry method can be deleted. Users should enable the Data Catalog API in the project identified by the name parameter (see Data Catalog Resource Project for more information).

Parameters
NameDescription
request .datacatalog.DeleteEntryRequest

The request object. Request message for DeleteEntry.

name str

Required. The name of the entry. Example: - projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id} This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

delete_entry_group

delete_entry_group(request: Optional[google.cloud.datacatalog_v1.types.datacatalog.DeleteEntryGroupRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes an EntryGroup. Only entry groups that do not contain entries can be deleted. Users should enable the Data Catalog API in the project identified by the name parameter (see Data Catalog Resource Project for more information).

Parameters
NameDescription
request .datacatalog.DeleteEntryGroupRequest

The request object. Request message for DeleteEntryGroup.

name str

Required. The name of the entry group. For example, projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}. This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

delete_tag

delete_tag(request: Optional[google.cloud.datacatalog_v1.types.datacatalog.DeleteTagRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes a tag.

Parameters
NameDescription
request .datacatalog.DeleteTagRequest

The request object. Request message for DeleteTag.

name str

Required. The name of the tag to delete. Example: - projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}/tags/{tag_id} This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

delete_tag_template

delete_tag_template(request: Optional[google.cloud.datacatalog_v1.types.datacatalog.DeleteTagTemplateRequest] = None, *, name: Optional[str] = None, force: Optional[bool] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes a tag template and all tags using the template. Users should enable the Data Catalog API in the project identified by the name parameter (see Data Catalog Resource Project for more information).

Parameters
NameDescription
request .datacatalog.DeleteTagTemplateRequest

The request object. Request message for DeleteTagTemplate.

name str

Required. The name of the tag template to delete. Example: - projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id} This corresponds to the name field on the request instance; if request is provided, this should not be set.

force bool

Required. Currently, this field must always be set to true. This confirms the deletion of any possible tags using this template. force = false will be supported in the future. This corresponds to the force field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

delete_tag_template_field

delete_tag_template_field(request: Optional[google.cloud.datacatalog_v1.types.datacatalog.DeleteTagTemplateFieldRequest] = None, *, name: Optional[str] = None, force: Optional[bool] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes a field in a tag template and all uses of that field. Users should enable the Data Catalog API in the project identified by the name parameter (see Data Catalog Resource Project for more information).

Parameters
NameDescription
request .datacatalog.DeleteTagTemplateFieldRequest

The request object. Request message for DeleteTagTemplateField.

name str

Required. The name of the tag template field to delete. Example: - projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}/fields/{tag_template_field_id} This corresponds to the name field on the request instance; if request is provided, this should not be set.

force bool

Required. Currently, this field must always be set to true. This confirms the deletion of this field from any tags using this field. force = false will be supported in the future. This corresponds to the force field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

entry_group_path

entry_group_path(project: str, location: str, entry_group: str)

Return a fully-qualified entry_group string.

entry_path

entry_path(project: str, location: str, entry_group: str, entry: str)

Return a fully-qualified entry string.

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
{@api.name}The constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
{@api.name}The constructed client.

get_entry

get_entry(request: Optional[google.cloud.datacatalog_v1.types.datacatalog.GetEntryRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets an entry.

Parameters
NameDescription
request .datacatalog.GetEntryRequest

The request object. Request message for GetEntry.

name str

Required. The name of the entry. Example: - projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id} This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
.datacatalog.EntryEntry Metadata. A Data Catalog Entry resource represents another resource in Google Cloud Platform (such as a BigQuery dataset or a Pub/Sub topic) or outside of Google Cloud Platform. Clients can use the linked_resource field in the Entry resource to refer to the original resource ID of the source system. An Entry resource contains resource details, such as its schema. An Entry can also be used to attach flexible metadata, such as a Tag.

get_entry_group

get_entry_group(request: Optional[google.cloud.datacatalog_v1.types.datacatalog.GetEntryGroupRequest] = None, *, name: Optional[str] = None, read_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets an EntryGroup.

Parameters
NameDescription
request .datacatalog.GetEntryGroupRequest

The request object. Request message for GetEntryGroup.

name str

Required. The name of the entry group. For example, projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}. This corresponds to the name field on the request instance; if request is provided, this should not be set.

read_mask .field_mask.FieldMask

The fields to return. If not set or empty, all fields are returned. This corresponds to the read_mask field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
.datacatalog.EntryGroupEntryGroup Metadata. An EntryGroup resource represents a logical grouping of zero or more Data Catalog Entry resources.

get_iam_policy

get_iam_policy(request: Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None, *, resource: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets the access control policy for a resource. A NOT_FOUND error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it.

Supported resources are:

  • Tag templates.
  • Entries.
  • Entry groups. Note, this method cannot be used to manage policies for BigQuery, Pub/Sub and any external Google Cloud Platform resources synced to Data Catalog.

Callers must have following Google IAM permission

  • datacatalog.tagTemplates.getIamPolicy to get policies on tag templates.
  • datacatalog.entries.getIamPolicy to get policies on entries.
  • datacatalog.entryGroups.getIamPolicy to get policies on entry groups.
Parameters
NameDescription
request .iam_policy.GetIamPolicyRequest

The request object. Request message for GetIamPolicy method.

resource str

REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. This corresponds to the resource field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
.policy.PolicyDefines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions (defined by IAM or configured by users). A binding can optionally specify a condition, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** :: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01t00:00:00.000z')",="" }="" }="" ]="" }="" **yaml="" example**="" ::="" bindings:="" -="" members:="" -="" user:mike@example.com="" -="" group:admins@example.com="" -="" domain:google.com="" -="" serviceaccount:my-project-id@appspot.gserviceaccount.com="" role:="" roles/resourcemanager.organizationadmin="" -="" members:="" -="" user:eve@example.com="" role:="" roles/resourcemanager.organizationviewer="" condition:="" title:="" expirable="" access="" description:="" does="" not="" grant="" access="" after="" sep="" 2020="" expression:="" request.time="">< timestamp('2020-10-01t00:00:00.000z')="" for="" a="" description="" of="" iam="" and="" its="" features,="" see="" the="">IAM developer's guide __.

get_tag_template

get_tag_template(request: Optional[google.cloud.datacatalog_v1.types.datacatalog.GetTagTemplateRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets a tag template.

Parameters
NameDescription
request .datacatalog.GetTagTemplateRequest

The request object. Request message for GetTagTemplate.

name str

Required. The name of the tag template. Example: - projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id} This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
.tags.TagTemplateA tag template defines a tag, which can have one or more typed fields. The template is used to create and attach the tag to GCP resources. Tag template roles __ provide permissions to create, edit, and use the template. See, for example, the TagTemplate User __ role, which includes permission to use the tag template to tag resources.

get_transport_class

get_transport_class()

Return an appropriate transport class.

list_entries

list_entries(request: Optional[google.cloud.datacatalog_v1.types.datacatalog.ListEntriesRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists entries.

Parameters
NameDescription
request .datacatalog.ListEntriesRequest

The request object. Request message for ListEntries.

parent str

Required. The name of the entry group that contains the entries, which can be provided in URL format. Example: - projects/{project_id}/locations/{location}/entryGroups/{entry_group_id} This corresponds to the parent field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
.pagers.ListEntriesAsyncPagerResponse message for ListEntries. Iterating over this object will yield results and resolve additional pages automatically.

list_entry_groups

list_entry_groups(request: Optional[google.cloud.datacatalog_v1.types.datacatalog.ListEntryGroupsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists entry groups.

Parameters
NameDescription
request .datacatalog.ListEntryGroupsRequest

The request object. Request message for ListEntryGroups.

parent str

Required. The name of the location that contains the entry groups, which can be provided in URL format. Example: - projects/{project_id}/locations/{location} This corresponds to the parent field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
.pagers.ListEntryGroupsAsyncPagerResponse message for ListEntryGroups. Iterating over this object will yield results and resolve additional pages automatically.

list_tags

list_tags(request: Optional[google.cloud.datacatalog_v1.types.datacatalog.ListTagsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists the tags on an xref_Entry.

Parameters
NameDescription
request .datacatalog.ListTagsRequest

The request object. Request message for ListTags.

parent str

Required. The name of the Data Catalog resource to list the tags of. The resource could be an Entry or an EntryGroup. Examples: - projects/{project_id}/locations/{location}/entryGroups/{entry_group_id} - projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id} This corresponds to the parent field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
.pagers.ListTagsAsyncPagerResponse message for ListTags. Iterating over this object will yield results and resolve additional pages automatically.

lookup_entry

lookup_entry(request: Optional[google.cloud.datacatalog_v1.types.datacatalog.LookupEntryRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Get an entry by target resource name. This method allows clients to use the resource name from the source Google Cloud Platform service to get the Data Catalog Entry.

Parameters
NameDescription
request .datacatalog.LookupEntryRequest

The request object. Request message for LookupEntry.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
.datacatalog.EntryEntry Metadata. A Data Catalog Entry resource represents another resource in Google Cloud Platform (such as a BigQuery dataset or a Pub/Sub topic) or outside of Google Cloud Platform. Clients can use the linked_resource field in the Entry resource to refer to the original resource ID of the source system. An Entry resource contains resource details, such as its schema. An Entry can also be used to attach flexible metadata, such as a Tag.

rename_tag_template_field

rename_tag_template_field(request: Optional[google.cloud.datacatalog_v1.types.datacatalog.RenameTagTemplateFieldRequest] = None, *, name: Optional[str] = None, new_tag_template_field_id: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Renames a field in a tag template. The user should enable the Data Catalog API in the project identified by the name parameter (see Data Catalog Resource Project <https://cloud.google.com/data-catalog/docs/concepts/resource-project>__ for more information).

Parameters
NameDescription
request .datacatalog.RenameTagTemplateFieldRequest

The request object. Request message for RenameTagTemplateField.

name str

Required. The name of the tag template. Example: - projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}/fields/{tag_template_field_id} This corresponds to the name field on the request instance; if request is provided, this should not be set.

new_tag_template_field_id str

Required. The new ID of this tag template field. For example, my_new_field. This corresponds to the new_tag_template_field_id field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
.tags.TagTemplateFieldThe template for an individual field within a tag template.

search_catalog

search_catalog(request: Optional[google.cloud.datacatalog_v1.types.datacatalog.SearchCatalogRequest] = None, *, scope: Optional[google.cloud.datacatalog_v1.types.datacatalog.SearchCatalogRequest.Scope] = None, query: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Searches Data Catalog for multiple resources like entries, tags that match a query.

This is a custom method (https://cloud.google.com/apis/design/custom_methods) and does not return the complete resource, only the resource identifier and high level fields. Clients can subsequentally call Get methods.

Note that Data Catalog search queries do not guarantee full recall. Query results that match your query may not be returned, even in subsequent result pages. Also note that results returned (and not returned) can vary across repeated search queries.

See Data Catalog Search Syntax <https://cloud.google.com/data-catalog/docs/how-to/search-reference>__ for more information.

Parameters
NameDescription
request .datacatalog.SearchCatalogRequest

The request object. Request message for SearchCatalog.

scope .datacatalog.SearchCatalogRequest.Scope

Required. The scope of this search request. A scope that has empty include_org_ids, include_project_ids AND false include_gcp_public_datasets is considered invalid. Data Catalog will return an error in such a case. This corresponds to the scope field on the request instance; if request is provided, this should not be set.

query str

Required. The query string in search query syntax. The query must be non-empty. Query strings can be simple as "x" or more qualified as: - name:x - column:x - description:y Note: Query tokens need to have a minimum of 3 characters for substring matching to work correctly. See Data Catalog Search Syntax https://cloud.google.com/data-catalog/docs/how-to/search-reference__ for more information. This corresponds to the query field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
.pagers.SearchCatalogAsyncPagerResponse message for SearchCatalog. Iterating over this object will yield results and resolve additional pages automatically.

set_iam_policy

set_iam_policy(request: Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None, *, resource: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Sets the access control policy for a resource. Replaces any existing policy. Supported resources are:

  • Tag templates.
  • Entries.
  • Entry groups. Note, this method cannot be used to manage policies for BigQuery, Pub/Sub and any external Google Cloud Platform resources synced to Data Catalog.

Callers must have following Google IAM permission

  • datacatalog.tagTemplates.setIamPolicy to set policies on tag templates.
  • datacatalog.entries.setIamPolicy to set policies on entries.
  • datacatalog.entryGroups.setIamPolicy to set policies on entry groups.
Parameters
NameDescription
request .iam_policy.SetIamPolicyRequest

The request object. Request message for SetIamPolicy method.

resource str

REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. This corresponds to the resource field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
.policy.PolicyDefines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions (defined by IAM or configured by users). A binding can optionally specify a condition, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** :: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01t00:00:00.000z')",="" }="" }="" ]="" }="" **yaml="" example**="" ::="" bindings:="" -="" members:="" -="" user:mike@example.com="" -="" group:admins@example.com="" -="" domain:google.com="" -="" serviceaccount:my-project-id@appspot.gserviceaccount.com="" role:="" roles/resourcemanager.organizationadmin="" -="" members:="" -="" user:eve@example.com="" role:="" roles/resourcemanager.organizationviewer="" condition:="" title:="" expirable="" access="" description:="" does="" not="" grant="" access="" after="" sep="" 2020="" expression:="" request.time="">< timestamp('2020-10-01t00:00:00.000z')="" for="" a="" description="" of="" iam="" and="" its="" features,="" see="" the="">IAM developer's guide __.

tag_path

tag_path(project: str, location: str, entry_group: str, entry: str, tag: str)

Return a fully-qualified tag string.

tag_template_field_path

tag_template_field_path(project: str, location: str, tag_template: str, field: str)

Return a fully-qualified tag_template_field string.

tag_template_path

tag_template_path(project: str, location: str, tag_template: str)

Return a fully-qualified tag_template string.

test_iam_permissions

test_iam_permissions(request: Optional[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Returns the caller's permissions on a resource. If the resource does not exist, an empty set of permissions is returned (We don't return a NOT_FOUND error).

Supported resources are:

  • Tag templates.
  • Entries.
  • Entry groups. Note, this method cannot be used to manage policies for BigQuery, Pub/Sub and any external Google Cloud Platform resources synced to Data Catalog.

A caller is not required to have Google IAM permission to make this request.

Parameters
NameDescription
request .iam_policy.TestIamPermissionsRequest

The request object. Request message for TestIamPermissions method.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
.iam_policy.TestIamPermissionsResponseResponse message for TestIamPermissions method.

update_entry

update_entry(request: Optional[google.cloud.datacatalog_v1.types.datacatalog.UpdateEntryRequest] = None, *, entry: Optional[google.cloud.datacatalog_v1.types.datacatalog.Entry] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates an existing entry. Users should enable the Data Catalog API in the project identified by the entry.name parameter (see Data Catalog Resource Project for more information).

Parameters
NameDescription
request .datacatalog.UpdateEntryRequest

The request object. Request message for UpdateEntry.

entry .datacatalog.Entry

Required. The updated entry. The "name" field must be set. This corresponds to the entry field on the request instance; if request is provided, this should not be set.

update_mask .field_mask.FieldMask

The fields to update on the entry. If absent or empty, all modifiable fields are updated. The following fields are modifiable: - For entries with type DATA_STREAM: - schema - For entries with type FILESET - schema - display_name - description - gcs_fileset_spec - gcs_fileset_spec.file_patterns - For entries with user_specified_type - schema - display_name - description - user_specified_type - user_specified_system - linked_resource - source_system_timestamps This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
.datacatalog.EntryEntry Metadata. A Data Catalog Entry resource represents another resource in Google Cloud Platform (such as a BigQuery dataset or a Pub/Sub topic) or outside of Google Cloud Platform. Clients can use the linked_resource field in the Entry resource to refer to the original resource ID of the source system. An Entry resource contains resource details, such as its schema. An Entry can also be used to attach flexible metadata, such as a Tag.

update_entry_group

update_entry_group(request: Optional[google.cloud.datacatalog_v1.types.datacatalog.UpdateEntryGroupRequest] = None, *, entry_group: Optional[google.cloud.datacatalog_v1.types.datacatalog.EntryGroup] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates an EntryGroup. The user should enable the Data Catalog API in the project identified by the entry_group.name parameter (see Data Catalog Resource Project for more information).

Parameters
NameDescription
request .datacatalog.UpdateEntryGroupRequest

The request object. Request message for UpdateEntryGroup.

entry_group .datacatalog.EntryGroup

Required. The updated entry group. "name" field must be set. This corresponds to the entry_group field on the request instance; if request is provided, this should not be set.

update_mask .field_mask.FieldMask

The fields to update on the entry group. If absent or empty, all modifiable fields are updated. This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
.datacatalog.EntryGroupEntryGroup Metadata. An EntryGroup resource represents a logical grouping of zero or more Data Catalog Entry resources.

update_tag

update_tag(request: Optional[google.cloud.datacatalog_v1.types.datacatalog.UpdateTagRequest] = None, *, tag: Optional[google.cloud.datacatalog_v1.types.tags.Tag] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates an existing tag.

Parameters
NameDescription
request .datacatalog.UpdateTagRequest

The request object. Request message for UpdateTag.

tag .tags.Tag

Required. The updated tag. The "name" field must be set. This corresponds to the tag field on the request instance; if request is provided, this should not be set.

update_mask .field_mask.FieldMask

The fields to update on the Tag. If absent or empty, all modifiable fields are updated. Currently the only modifiable field is the field fields. This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
.tags.TagTags are used to attach custom metadata to Data Catalog resources. Tags conform to the specifications within their tag template. See Data Catalog IAM __ for information on the permissions needed to create or view tags.

update_tag_template

update_tag_template(request: Optional[google.cloud.datacatalog_v1.types.datacatalog.UpdateTagTemplateRequest] = None, *, tag_template: Optional[google.cloud.datacatalog_v1.types.tags.TagTemplate] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates a tag template. This method cannot be used to update the fields of a template. The tag template fields are represented as separate resources and should be updated using their own create/update/delete methods. Users should enable the Data Catalog API in the project identified by the tag_template.name parameter (see Data Catalog Resource Project for more information).

Parameters
NameDescription
request .datacatalog.UpdateTagTemplateRequest

The request object. Request message for UpdateTagTemplate.

tag_template .tags.TagTemplate

Required. The template to update. The "name" field must be set. This corresponds to the tag_template field on the request instance; if request is provided, this should not be set.

update_mask .field_mask.FieldMask

The field mask specifies the parts of the template to overwrite. Allowed fields: - display_name If absent or empty, all of the allowed fields above will be updated. This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
.tags.TagTemplateA tag template defines a tag, which can have one or more typed fields. The template is used to create and attach the tag to GCP resources. Tag template roles __ provide permissions to create, edit, and use the template. See, for example, the TagTemplate User __ role, which includes permission to use the tag template to tag resources.

update_tag_template_field

update_tag_template_field(request: Optional[google.cloud.datacatalog_v1.types.datacatalog.UpdateTagTemplateFieldRequest] = None, *, name: Optional[str] = None, tag_template_field: Optional[google.cloud.datacatalog_v1.types.tags.TagTemplateField] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates a field in a tag template. This method cannot be used to update the field type. Users should enable the Data Catalog API in the project identified by the name parameter (see Data Catalog Resource Project for more information).

Parameters
NameDescription
request .datacatalog.UpdateTagTemplateFieldRequest

The request object. Request message for UpdateTagTemplateField.

name str

Required. The name of the tag template field. Example: - projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}/fields/{tag_template_field_id} This corresponds to the name field on the request instance; if request is provided, this should not be set.

tag_template_field .tags.TagTemplateField

Required. The template to update. This corresponds to the tag_template_field field on the request instance; if request is provided, this should not be set.

update_mask .field_mask.FieldMask

Optional. The field mask specifies the parts of the template to be updated. Allowed fields: - display_name - type.enum_type - is_required If update_mask is not set or empty, all of the allowed fields above will be updated. When updating an enum type, the provided values will be merged with the existing values. Therefore, enum values can only be added, existing enum values cannot be deleted nor renamed. Updating a template field from optional to required is NOT allowed. This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
.tags.TagTemplateFieldThe template for an individual field within a tag template.