DataCatalogAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.datacatalog_v1.services.data_catalog.transports.base.DataCatalogTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
Data Catalog API service allows you to discover, understand, and manage your data.
Properties
transport
Returns the transport used by the client instance.
Returns | |
---|---|
Type | Description |
DataCatalogTransport | The transport used by the client instance. |
Methods
DataCatalogAsyncClient
DataCatalogAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.datacatalog_v1.services.data_catalog.transports.base.DataCatalogTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
Instantiates the data catalog client.
Parameters | |
---|---|
Name | Description |
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,
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 |
Exceptions | |
---|---|
Type | Description |
google.auth.exceptions.MutualTlsChannelError | If mutual TLS transport creation failed for any reason. |
cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Union[
google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
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
.
Parameters | |
---|---|
Name | Description |
request |
The request object. Request message for |
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. |
common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
create_entry
create_entry(
request: typing.Optional[
typing.Union[
google.cloud.datacatalog_v1.types.datacatalog.CreateEntryRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
entry_id: typing.Optional[str] = None,
entry: typing.Optional[google.cloud.datacatalog_v1.types.datacatalog.Entry] = None,
retry: typing.Union[
google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.datacatalog_v1.types.datacatalog.Entry
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 <https://cloud.google.com/data-catalog/docs/concepts/resource-project>
__.
An entry group can have a maximum of 100,000 entries.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datacatalog_v1
async def sample_create_entry():
# Create a client
client = datacatalog_v1.DataCatalogAsyncClient()
# Initialize request argument(s)
entry = datacatalog_v1.Entry()
entry.type_ = "LOOK"
entry.integrated_system = "VERTEX_AI"
entry.gcs_fileset_spec.file_patterns = ['file_patterns_value1', 'file_patterns_value2']
request = datacatalog_v1.CreateEntryRequest(
parent="parent_value",
entry_id="entry_id_value",
entry=entry,
)
# Make the request
response = await client.create_entry(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.datacatalog_v1.types.CreateEntryRequest, dict]]
The request object. Request message for CreateEntry. |
parent |
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. This corresponds to the |
entry_id |
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. This corresponds to the |
entry |
Entry
Required. The entry to create. This corresponds to the |
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 | |
---|---|
Type | Description |
google.cloud.datacatalog_v1.types.Entry | Entry metadata. A Data Catalog entry represents another resource in Google Cloud Platform (such as a BigQuery dataset or a Pub/Sub topic) or outside of it. You 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, for example, its schema. Additionally, you can attach flexible metadata to an entry in the form of a Tag. |
create_entry_group
create_entry_group(
request: typing.Optional[
typing.Union[
google.cloud.datacatalog_v1.types.datacatalog.CreateEntryGroupRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
entry_group_id: typing.Optional[str] = None,
entry_group: typing.Optional[
google.cloud.datacatalog_v1.types.datacatalog.EntryGroup
] = None,
retry: typing.Union[
google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.datacatalog_v1.types.datacatalog.EntryGroup
Creates an entry group.
An entry group contains logically related entries together with
Cloud Identity and Access
Management </data-catalog/docs/concepts/iam>
__ 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 <https://cloud.google.com/data-catalog/docs/concepts/resource-project>
__.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datacatalog_v1
async def sample_create_entry_group():
# Create a client
client = datacatalog_v1.DataCatalogAsyncClient()
# Initialize request argument(s)
request = datacatalog_v1.CreateEntryGroupRequest(
parent="parent_value",
entry_group_id="entry_group_id_value",
)
# Make the request
response = await client.create_entry_group(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.datacatalog_v1.types.CreateEntryGroupRequest, dict]]
The request object. Request message for CreateEntryGroup. |
parent |
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. This corresponds to the |
entry_group_id |
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. This corresponds to the |
entry_group |
EntryGroup
The entry group to create. Defaults to empty. This corresponds to the |
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 | |
---|---|
Type | Description |
google.cloud.datacatalog_v1.types.EntryGroup | Entry group metadata. An EntryGroup resource represents a logical grouping of zero or more Data Catalog Entry resources. |
create_tag
create_tag(
request: typing.Optional[
typing.Union[
google.cloud.datacatalog_v1.types.datacatalog.CreateTagRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
tag: typing.Optional[google.cloud.datacatalog_v1.types.tags.Tag] = None,
retry: typing.Union[
google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.datacatalog_v1.types.tags.Tag
Creates a tag and assigns it to:
- An xref_Entry if the method
name is
projects.locations.entryGroups.entries.tags.create
. - Or xref_EntryGroupif 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.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datacatalog_v1
async def sample_create_tag():
# Create a client
client = datacatalog_v1.DataCatalogAsyncClient()
# Initialize request argument(s)
tag = datacatalog_v1.Tag()
tag.column = "column_value"
tag.template = "template_value"
request = datacatalog_v1.CreateTagRequest(
parent="parent_value",
tag=tag,
)
# Make the request
response = await client.create_tag(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.datacatalog_v1.types.CreateTagRequest, dict]]
The request object. Request message for CreateTag. |
parent |
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. This corresponds to the |
tag |
Tag
Required. The tag to create. This corresponds to the |
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 | |
---|---|
Type | Description |
google.cloud.datacatalog_v1.types.Tag | Tags contain custom metadata and are attached to Data Catalog resources. Tags conform with the specification of their tag template. See [Data Catalog IAM](\ https://cloud.google.com/data-catalog/docs/concepts/iam) for information on the permissions needed to create or view tags. |
create_tag_template
create_tag_template(
request: typing.Optional[
typing.Union[
google.cloud.datacatalog_v1.types.datacatalog.CreateTagTemplateRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
tag_template_id: typing.Optional[str] = None,
tag_template: typing.Optional[
google.cloud.datacatalog_v1.types.tags.TagTemplate
] = None,
retry: typing.Union[
google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.datacatalog_v1.types.tags.TagTemplate
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.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datacatalog_v1
async def sample_create_tag_template():
# Create a client
client = datacatalog_v1.DataCatalogAsyncClient()
# Initialize request argument(s)
request = datacatalog_v1.CreateTagTemplateRequest(
parent="parent_value",
tag_template_id="tag_template_id_value",
)
# Make the request
response = await client.create_tag_template(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.datacatalog_v1.types.CreateTagTemplateRequest, dict]]
The request object. Request message for CreateTagTemplate. |
parent |
Required. The name of the project and the template location |
tag_template_id |
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. This corresponds to the |
tag_template |
TagTemplate
Required. The tag template to create. This corresponds to the |
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 | |
---|---|
Type | Description |
google.cloud.datacatalog_v1.types.TagTemplate | A tag template defines a tag that can have one or more typed fields. The template is used to create tags that are attached to Google Cloud resources. [Tag template roles] (https://cloud.google.com/iam/docs/understanding-roles#data-catalog-roles) provide permissions to create, edit, and use the template. For example, see the [TagTemplate User] (https://cloud.google.com/data-catalog/docs/how-to/template-user) role that includes a permission to use the tag template to tag resources. |
create_tag_template_field
create_tag_template_field(
request: typing.Optional[
typing.Union[
google.cloud.datacatalog_v1.types.datacatalog.CreateTagTemplateFieldRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
tag_template_field_id: typing.Optional[str] = None,
tag_template_field: typing.Optional[
google.cloud.datacatalog_v1.types.tags.TagTemplateField
] = None,
retry: typing.Union[
google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.datacatalog_v1.types.tags.TagTemplateField
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 <https://cloud.google.com/data-catalog/docs/concepts/resource-project>
__.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datacatalog_v1
async def sample_create_tag_template_field():
# Create a client
client = datacatalog_v1.DataCatalogAsyncClient()
# Initialize request argument(s)
tag_template_field = datacatalog_v1.TagTemplateField()
tag_template_field.type_.primitive_type = "RICHTEXT"
request = datacatalog_v1.CreateTagTemplateFieldRequest(
parent="parent_value",
tag_template_field_id="tag_template_field_id_value",
tag_template_field=tag_template_field,
)
# Make the request
response = await client.create_tag_template_field(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.datacatalog_v1.types.CreateTagTemplateFieldRequest, dict]]
The request object. Request message for CreateTagTemplateField. |
parent |
Required. The name of the project and the template location |
tag_template_field_id |
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. This corresponds to the |
tag_template_field |
TagTemplateField
Required. The tag template field to create. This corresponds to the |
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 | |
---|---|
Type | Description |
google.cloud.datacatalog_v1.types.TagTemplateField | The template for an individual field within a tag template. |
delete_entry
delete_entry(
request: typing.Optional[
typing.Union[
google.cloud.datacatalog_v1.types.datacatalog.DeleteEntryRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes an existing entry.
You can delete only the entries created by the xref_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 <https://cloud.google.com/data-catalog/docs/concepts/resource-project>
__.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datacatalog_v1
async def sample_delete_entry():
# Create a client
client = datacatalog_v1.DataCatalogAsyncClient()
# Initialize request argument(s)
request = datacatalog_v1.DeleteEntryRequest(
name="name_value",
)
# Make the request
await client.delete_entry(request=request)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.datacatalog_v1.types.DeleteEntryRequest, dict]]
The request object. Request message for DeleteEntry. |
name |
Required. The name of the entry to delete. This corresponds to the |
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: typing.Optional[
typing.Union[
google.cloud.datacatalog_v1.types.datacatalog.DeleteEntryGroupRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
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 <https://cloud.google.com/data-catalog/docs/concepts/resource-project>
__.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datacatalog_v1
async def sample_delete_entry_group():
# Create a client
client = datacatalog_v1.DataCatalogAsyncClient()
# Initialize request argument(s)
request = datacatalog_v1.DeleteEntryGroupRequest(
name="name_value",
)
# Make the request
await client.delete_entry_group(request=request)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.datacatalog_v1.types.DeleteEntryGroupRequest, dict]]
The request object. Request message for DeleteEntryGroup. |
name |
Required. The name of the entry group to delete. This corresponds to the |
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_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Union[
google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
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
.
Parameters | |
---|---|
Name | Description |
request |
The request object. Request message for |
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: typing.Optional[
typing.Union[
google.cloud.datacatalog_v1.types.datacatalog.DeleteTagRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a tag.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datacatalog_v1
async def sample_delete_tag():
# Create a client
client = datacatalog_v1.DataCatalogAsyncClient()
# Initialize request argument(s)
request = datacatalog_v1.DeleteTagRequest(
name="name_value",
)
# Make the request
await client.delete_tag(request=request)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.datacatalog_v1.types.DeleteTagRequest, dict]]
The request object. Request message for DeleteTag. |
name |
Required. The name of the tag to delete. This corresponds to the |
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: typing.Optional[
typing.Union[
google.cloud.datacatalog_v1.types.datacatalog.DeleteTagTemplateRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
force: typing.Optional[bool] = None,
retry: typing.Union[
google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
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 <https://cloud.google.com/data-catalog/docs/concepts/resource-project>
__.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datacatalog_v1
async def sample_delete_tag_template():
# Create a client
client = datacatalog_v1.DataCatalogAsyncClient()
# Initialize request argument(s)
request = datacatalog_v1.DeleteTagTemplateRequest(
name="name_value",
force=True,
)
# Make the request
await client.delete_tag_template(request=request)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.datacatalog_v1.types.DeleteTagTemplateRequest, dict]]
The request object. Request message for DeleteTagTemplate. |
name |
Required. The name of the tag template to delete. This corresponds to the |
force |
Required. If true, deletes all tags that use this template. Currently, |
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: typing.Optional[
typing.Union[
google.cloud.datacatalog_v1.types.datacatalog.DeleteTagTemplateFieldRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
force: typing.Optional[bool] = None,
retry: typing.Union[
google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
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 <https://cloud.google.com/data-catalog/docs/concepts/resource-project>
__.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datacatalog_v1
async def sample_delete_tag_template_field():
# Create a client
client = datacatalog_v1.DataCatalogAsyncClient()
# Initialize request argument(s)
request = datacatalog_v1.DeleteTagTemplateFieldRequest(
name="name_value",
force=True,
)
# Make the request
await client.delete_tag_template_field(request=request)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.datacatalog_v1.types.DeleteTagTemplateFieldRequest, dict]]
The request object. Request message for DeleteTagTemplateField. |
name |
Required. The name of the tag template field to delete. This corresponds to the |
force |
Required. If true, deletes this field from any tags that use it. Currently, |
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) -> str
Returns a fully-qualified entry_group string.
entry_path
entry_path(project: str, location: str, entry_group: str, entry: str) -> str
Returns 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 | |
---|---|
Name | Description |
filename |
str
The path to the service account private key json file. |
Returns | |
---|---|
Type | Description |
DataCatalogAsyncClient | The constructed client. |
from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
Parameter | |
---|---|
Name | Description |
info |
dict
The service account private key info. |
Returns | |
---|---|
Type | Description |
DataCatalogAsyncClient | 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 | |
---|---|
Name | Description |
filename |
str
The path to the service account private key json file. |
Returns | |
---|---|
Type | Description |
DataCatalogAsyncClient | The constructed client. |
get_entry
get_entry(
request: typing.Optional[
typing.Union[
google.cloud.datacatalog_v1.types.datacatalog.GetEntryRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.datacatalog_v1.types.datacatalog.Entry
Gets an entry.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datacatalog_v1
async def sample_get_entry():
# Create a client
client = datacatalog_v1.DataCatalogAsyncClient()
# Initialize request argument(s)
request = datacatalog_v1.GetEntryRequest(
name="name_value",
)
# Make the request
response = await client.get_entry(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.datacatalog_v1.types.GetEntryRequest, dict]]
The request object. Request message for GetEntry. |
name |
Required. The name of the entry to get. This corresponds to the |
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 | |
---|---|
Type | Description |
google.cloud.datacatalog_v1.types.Entry | Entry metadata. A Data Catalog entry represents another resource in Google Cloud Platform (such as a BigQuery dataset or a Pub/Sub topic) or outside of it. You 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, for example, its schema. Additionally, you can attach flexible metadata to an entry in the form of a Tag. |
get_entry_group
get_entry_group(
request: typing.Optional[
typing.Union[
google.cloud.datacatalog_v1.types.datacatalog.GetEntryGroupRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
read_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Union[
google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.datacatalog_v1.types.datacatalog.EntryGroup
Gets an entry group.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datacatalog_v1
async def sample_get_entry_group():
# Create a client
client = datacatalog_v1.DataCatalogAsyncClient()
# Initialize request argument(s)
request = datacatalog_v1.GetEntryGroupRequest(
name="name_value",
)
# Make the request
response = await client.get_entry_group(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.datacatalog_v1.types.GetEntryGroupRequest, dict]]
The request object. Request message for GetEntryGroup. |
name |
Required. The name of the entry group to get. This corresponds to the |
read_mask |
The fields to return. If empty or omitted, all fields are returned. This corresponds to the |
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 | |
---|---|
Type | Description |
google.cloud.datacatalog_v1.types.EntryGroup | Entry group metadata. An EntryGroup resource represents a logical grouping of zero or more Data Catalog Entry resources. |
get_iam_policy
get_iam_policy(
request: typing.Optional[
typing.Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]
] = None,
*,
resource: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
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.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datacatalog_v1
from google.iam.v1 import iam_policy_pb2 # type: ignore
async def sample_get_iam_policy():
# Create a client
client = datacatalog_v1.DataCatalogAsyncClient()
# Initialize request argument(s)
request = iam_policy_pb2.GetIamPolicyRequest(
resource="resource_value",
)
# Make the request
response = await client.get_iam_policy(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]]
The request object. Request message for |
resource |
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 |
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 | |
---|---|
Type | Description |
google.iam.v1.policy_pb2.Policy | An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](\ https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** :literal:\ { "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')",="" }="" }="" ],="" "etag":="" "bwwwja0yfja=", " version":="" 3="">\ \ **YAML example:** :literal:\ 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')="" etag:="" bwwwja0yfja="version:">\ \ For a description of IAM and its features, see the [IAM documentation](\ https://cloud.google.com/iam/docs/). |
get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
The client cert source is determined in the following order:
(1) if GOOGLE_API_USE_CLIENT_CERTIFICATE
environment variable is not "true", the
client cert source is None.
(2) if client_options.client_cert_source
is provided, use the provided one; if the
default client cert source exists, use the default one; otherwise the client cert
source is None.
The API endpoint is determined in the following order:
(1) if client_options.api_endpoint
if provided, use the provided one.
(2) if GOOGLE_API_USE_CLIENT_CERTIFICATE
environment variable is "always", use the
default mTLS endpoint; if the environment variable is "never", use the default API
endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise
use the default API endpoint.
More details can be found at https://google.aip.dev/auth/4114.
Parameter | |
---|---|
Name | Description |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. Only the |
Exceptions | |
---|---|
Type | Description |
google.auth.exceptions.MutualTLSChannelError | If any errors happen. |
Returns | |
---|---|
Type | Description |
Tuple[str, Callable[[], Tuple[bytes, bytes]]] | returns the API endpoint and the client cert source to use. |
get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Union[
google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
Parameters | |
---|---|
Name | Description |
request |
The request object. Request message for |
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 | |
---|---|
Type | Description |
| An Operation object. |
get_tag_template
get_tag_template(
request: typing.Optional[
typing.Union[
google.cloud.datacatalog_v1.types.datacatalog.GetTagTemplateRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.datacatalog_v1.types.tags.TagTemplate
Gets a tag template.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datacatalog_v1
async def sample_get_tag_template():
# Create a client
client = datacatalog_v1.DataCatalogAsyncClient()
# Initialize request argument(s)
request = datacatalog_v1.GetTagTemplateRequest(
name="name_value",
)
# Make the request
response = await client.get_tag_template(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.datacatalog_v1.types.GetTagTemplateRequest, dict]]
The request object. Request message for GetTagTemplate. |
name |
Required. The name of the tag template to get. This corresponds to the |
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 | |
---|---|
Type | Description |
google.cloud.datacatalog_v1.types.TagTemplate | A tag template defines a tag that can have one or more typed fields. The template is used to create tags that are attached to Google Cloud resources. [Tag template roles] (https://cloud.google.com/iam/docs/understanding-roles#data-catalog-roles) provide permissions to create, edit, and use the template. For example, see the [TagTemplate User] (https://cloud.google.com/data-catalog/docs/how-to/template-user) role that includes a permission to use the tag template to tag resources. |
get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.datacatalog_v1.services.data_catalog.transports.base.DataCatalogTransport
]
)
Returns an appropriate transport class.
import_entries
import_entries(
request: typing.Optional[
typing.Union[
google.cloud.datacatalog_v1.types.datacatalog.ImportEntriesRequest, dict
]
] = None,
*,
retry: typing.Union[
google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
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
xref_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
xref_ImportEntriesMetadata
and an
xref_ImportEntriesResponse
message.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datacatalog_v1
async def sample_import_entries():
# Create a client
client = datacatalog_v1.DataCatalogAsyncClient()
# Initialize request argument(s)
request = datacatalog_v1.ImportEntriesRequest(
gcs_bucket_path="gcs_bucket_path_value",
parent="parent_value",
)
# Make the request
operation = client.import_entries(request=request)
print("Waiting for operation to complete...")
response = (await operation).result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.datacatalog_v1.types.ImportEntriesRequest, dict]]
The request object. Request message for ImportEntries 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 | |
---|---|
Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be ImportEntriesResponse Response message for long-running operation][google.longrunning.Operation] returned by the ImportEntries. |
list_entries
list_entries(
request: typing.Optional[
typing.Union[
google.cloud.datacatalog_v1.types.datacatalog.ListEntriesRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.datacatalog_v1.services.data_catalog.pagers.ListEntriesAsyncPager
Lists entries.
Note: Currently, this method can list only custom entries. To get a list of both custom and automatically created entries, use xref_SearchCatalog.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datacatalog_v1
async def sample_list_entries():
# Create a client
client = datacatalog_v1.DataCatalogAsyncClient()
# Initialize request argument(s)
request = datacatalog_v1.ListEntriesRequest(
parent="