MetadataServiceAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.dataplex_v1.services.metadata_service.transports.base.MetadataServiceTransport] = 'grpc_asyncio', client_options: 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>)
Metadata service manages metadata resources such as tables, filesets and partitions.
Properties
transport
Returns the transport used by the client instance.
Returns | |
---|---|
Type | Description |
MetadataServiceTransport | The transport used by the client instance. |
Methods
MetadataServiceAsyncClient
MetadataServiceAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.dataplex_v1.services.metadata_service.transports.base.MetadataServiceTransport] = 'grpc_asyncio', client_options: 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 metadata service 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. |
common_billing_account_path
common_billing_account_path(billing_account: str)
Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)
Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)
Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)
Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str)
Returns a fully-qualified project string.
create_entity
create_entity(request: Optional[Union[google.cloud.dataplex_v1.types.metadata_.CreateEntityRequest, dict]] = None, *, parent: Optional[str] = None, entity: Optional[google.cloud.dataplex_v1.types.metadata_.Entity] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Create a metadata entity.
from google.cloud import dataplex_v1
async def sample_create_entity():
# Create a client
client = dataplex_v1.MetadataServiceAsyncClient()
# Initialize request argument(s)
entity = dataplex_v1.Entity()
entity.id = "id_value"
entity.type_ = "FILESET"
entity.asset = "asset_value"
entity.data_path = "data_path_value"
entity.system = "BIGQUERY"
entity.format_.mime_type = "mime_type_value"
entity.schema.user_managed = True
request = dataplex_v1.CreateEntityRequest(
parent="parent_value",
entity=entity,
)
# Make the request
response = await client.create_entity(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.dataplex_v1.types.CreateEntityRequest, dict]
The request object. Create a metadata entity request. |
parent |
Required. The resource name of the parent zone: |
entity |
Entity
Required. Entity resource. 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.dataplex_v1.types.Entity | Represents tables and fileset metadata contained within a zone. |
create_partition
create_partition(request: Optional[Union[google.cloud.dataplex_v1.types.metadata_.CreatePartitionRequest, dict]] = None, *, parent: Optional[str] = None, partition: Optional[google.cloud.dataplex_v1.types.metadata_.Partition] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Create a metadata partition.
from google.cloud import dataplex_v1
async def sample_create_partition():
# Create a client
client = dataplex_v1.MetadataServiceAsyncClient()
# Initialize request argument(s)
partition = dataplex_v1.Partition()
partition.values = ['values_value_1', 'values_value_2']
partition.location = "location_value"
request = dataplex_v1.CreatePartitionRequest(
parent="parent_value",
partition=partition,
)
# Make the request
response = await client.create_partition(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.dataplex_v1.types.CreatePartitionRequest, dict]
The request object. Create metadata partition request. |
parent |
Required. The resource name of the parent zone: |
partition |
Partition
Required. Partition resource. 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.dataplex_v1.types.Partition | Represents partition metadata contained within entity instances. |
delete_entity
delete_entity(request: Optional[Union[google.cloud.dataplex_v1.types.metadata_.DeleteEntityRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Delete a metadata entity.
from google.cloud import dataplex_v1
async def sample_delete_entity():
# Create a client
client = dataplex_v1.MetadataServiceAsyncClient()
# Initialize request argument(s)
request = dataplex_v1.DeleteEntityRequest(
name="name_value",
etag="etag_value",
)
# Make the request
await client.delete_entity(request=request)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.dataplex_v1.types.DeleteEntityRequest, dict]
The request object. Delete a metadata entity request. |
name |
Required. The resource name of the entity: |
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_partition
delete_partition(request: Optional[Union[google.cloud.dataplex_v1.types.metadata_.DeletePartitionRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Delete a metadata partition.
from google.cloud import dataplex_v1
async def sample_delete_partition():
# Create a client
client = dataplex_v1.MetadataServiceAsyncClient()
# Initialize request argument(s)
request = dataplex_v1.DeletePartitionRequest(
name="name_value",
)
# Make the request
await client.delete_partition(request=request)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.dataplex_v1.types.DeletePartitionRequest, dict]
The request object. Delete metadata partition request. |
name |
Required. The resource name of the partition. format: |
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. |
entity_path
entity_path(project: str, location: str, lake: str, zone: str, entity: str)
Returns a fully-qualified entity 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 |
MetadataServiceAsyncClient | 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 |
MetadataServiceAsyncClient | 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 |
MetadataServiceAsyncClient | The constructed client. |
get_entity
get_entity(request: Optional[Union[google.cloud.dataplex_v1.types.metadata_.GetEntityRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Get a metadata entity.
from google.cloud import dataplex_v1
async def sample_get_entity():
# Create a client
client = dataplex_v1.MetadataServiceAsyncClient()
# Initialize request argument(s)
request = dataplex_v1.GetEntityRequest(
name="name_value",
)
# Make the request
response = await client.get_entity(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.dataplex_v1.types.GetEntityRequest, dict]
The request object. Get metadata entity request. |
name |
Required. The resource name of the entity: |
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.dataplex_v1.types.Entity | Represents tables and fileset metadata contained within a zone. |
get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: 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 variabel 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_partition
get_partition(request: Optional[Union[google.cloud.dataplex_v1.types.metadata_.GetPartitionRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Get a metadata partition of an entity.
from google.cloud import dataplex_v1
async def sample_get_partition():
# Create a client
client = dataplex_v1.MetadataServiceAsyncClient()
# Initialize request argument(s)
request = dataplex_v1.GetPartitionRequest(
name="name_value",
)
# Make the request
response = await client.get_partition(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.dataplex_v1.types.GetPartitionRequest, dict]
The request object. Get metadata partition request. |
name |
Required. The resource name of the partition: |
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.dataplex_v1.types.Partition | Represents partition metadata contained within entity instances. |
get_transport_class
get_transport_class()
Returns an appropriate transport class.
list_entities
list_entities(request: Optional[Union[google.cloud.dataplex_v1.types.metadata_.ListEntitiesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
List metadata entities in a zone.
from google.cloud import dataplex_v1
async def sample_list_entities():
# Create a client
client = dataplex_v1.MetadataServiceAsyncClient()
# Initialize request argument(s)
request = dataplex_v1.ListEntitiesRequest(
parent="parent_value",
view="FILESETS",
)
# Make the request
page_result = client.list_entities(request=request)
# Handle the response
async for response in page_result:
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.dataplex_v1.types.ListEntitiesRequest, dict]
The request object. List metadata entities request. |
parent |
Required. The resource name of the parent zone: |
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.dataplex_v1.services.metadata_service.pagers.ListEntitiesAsyncPager | List metadata entities response. Iterating over this object will yield results and resolve additional pages automatically. |
list_partitions
list_partitions(request: Optional[Union[google.cloud.dataplex_v1.types.metadata_.ListPartitionsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
List metadata partitions of an entity.
from google.cloud import dataplex_v1
async def sample_list_partitions():
# Create a client
client = dataplex_v1.MetadataServiceAsyncClient()
# Initialize request argument(s)
request = dataplex_v1.ListPartitionsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_partitions(request=request)
# Handle the response
async for response in page_result:
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.dataplex_v1.types.ListPartitionsRequest, dict]
The request object. List metadata partitions request. |
parent |
Required. The resource name of the parent entity: |
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.dataplex_v1.services.metadata_service.pagers.ListPartitionsAsyncPager | List metadata partitions response. Iterating over this object will yield results and resolve additional pages automatically. |
parse_common_billing_account_path
parse_common_billing_account_path(path: str)
Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str)
Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str)
Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str)
Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str)
Parse a project path into its component segments.
parse_entity_path
parse_entity_path(path: str)
Parses a entity path into its component segments.
parse_partition_path
parse_partition_path(path: str)
Parses a partition path into its component segments.
parse_zone_path
parse_zone_path(path: str)
Parses a zone path into its component segments.
partition_path
partition_path(
project: str, location: str, lake: str, zone: str, entity: str, partition: str
)
Returns a fully-qualified partition string.
update_entity
update_entity(request: Optional[Union[google.cloud.dataplex_v1.types.metadata_.UpdateEntityRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Update a metadata entity. Only supports full resource update.
from google.cloud import dataplex_v1
async def sample_update_entity():
# Create a client
client = dataplex_v1.MetadataServiceAsyncClient()
# Initialize request argument(s)
entity = dataplex_v1.Entity()
entity.id = "id_value"
entity.type_ = "FILESET"
entity.asset = "asset_value"
entity.data_path = "data_path_value"
entity.system = "BIGQUERY"
entity.format_.mime_type = "mime_type_value"
entity.schema.user_managed = True
request = dataplex_v1.UpdateEntityRequest(
entity=entity,
)
# Make the request
response = await client.update_entity(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.dataplex_v1.types.UpdateEntityRequest, dict]
The request object. Update a metadata entity request. The exiting entity will be fully replaced by the entity in the request. The entity ID is mutable. To modify the ID, use the current entity ID in the request URL and specify the new ID in the request body. |
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.dataplex_v1.types.Entity | Represents tables and fileset metadata contained within a zone. |
zone_path
zone_path(project: str, location: str, lake: str, zone: str)
Returns a fully-qualified zone string.