ContentServiceAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.dataplex_v1.services.content_service.transports.base.ContentServiceTransport] = '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>)
ContentService manages Notebook and SQL Scripts for Dataplex.
Inheritance
builtins.object > ContentServiceAsyncClientProperties
transport
Returns the transport used by the client instance.
Type | Description |
ContentServiceTransport | The transport used by the client instance. |
Methods
ContentServiceAsyncClient
ContentServiceAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.dataplex_v1.services.content_service.transports.base.ContentServiceTransport] = '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 content service client.
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, `.ContentServiceTransport`]
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 |
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.
content_path
content_path(project: str, location: str, lake: str, content: str)
Returns a fully-qualified content string.
create_content
create_content(request: Optional[Union[google.cloud.dataplex_v1.types.content.CreateContentRequest, dict]] = None, *, parent: Optional[str] = None, content: Optional[google.cloud.dataplex_v1.types.analyze.Content] = 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 content.
from google.cloud import dataplex_v1
def sample_create_content():
# Create a client
client = dataplex_v1.ContentServiceClient()
# Initialize request argument(s)
content = dataplex_v1.Content()
content.data_text = "data_text_value"
content.sql_script.engine = "SPARK"
content.path = "path_value"
request = dataplex_v1.CreateContentRequest(
parent="parent_value",
content=content,
)
# Make the request
response = client.create_content(request=request)
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.dataplex_v1.types.CreateContentRequest, dict]
The request object. Create content request. |
parent |
`str`
Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id} This corresponds to the |
content |
Content
Required. Content 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. |
Type | Description |
google.cloud.dataplex_v1.types.Content | Content represents a user-visible notebook or a sql script |
delete_content
delete_content(request: Optional[Union[google.cloud.dataplex_v1.types.content.DeleteContentRequest, 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 content.
from google.cloud import dataplex_v1
def sample_delete_content():
# Create a client
client = dataplex_v1.ContentServiceClient()
# Initialize request argument(s)
request = dataplex_v1.DeleteContentRequest(
name="name_value",
)
# Make the request
client.delete_content(request=request)
Name | Description |
request |
Union[google.cloud.dataplex_v1.types.DeleteContentRequest, dict]
The request object. Delete content request. |
name |
`str`
Required. The resource name of the content: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id} 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. |
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Name | Description |
filename |
str
The path to the service account private key json file. |
Type | Description |
ContentServiceAsyncClient | 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.
Name | Description |
info |
dict
The service account private key info. |
Type | Description |
ContentServiceAsyncClient | 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.
Name | Description |
filename |
str
The path to the service account private key json file. |
Type | Description |
ContentServiceAsyncClient | The constructed client. |
get_content
get_content(request: Optional[Union[google.cloud.dataplex_v1.types.content.GetContentRequest, 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 content resource.
from google.cloud import dataplex_v1
def sample_get_content():
# Create a client
client = dataplex_v1.ContentServiceClient()
# Initialize request argument(s)
request = dataplex_v1.GetContentRequest(
name="name_value",
)
# Make the request
response = client.get_content(request=request)
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.dataplex_v1.types.GetContentRequest, dict]
The request object. Get content request. |
name |
`str`
Required. The resource name of the content: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id} 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. |
Type | Description |
google.cloud.dataplex_v1.types.Content | Content represents a user-visible notebook or a sql script |
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.
Name | Description |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. Only the |
Type | Description |
google.auth.exceptions.MutualTLSChannelError | If any errors happen. |
Type | Description |
Tuple[str, Callable[[], Tuple[bytes, bytes]]] | returns the API endpoint and the client cert source to use. |
get_transport_class
get_transport_class()
Returns an appropriate transport class.
lake_path
lake_path(project: str, location: str, lake: str)
Returns a fully-qualified lake string.
list_content
list_content(request: Optional[Union[google.cloud.dataplex_v1.types.content.ListContentRequest, 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 content.
from google.cloud import dataplex_v1
def sample_list_content():
# Create a client
client = dataplex_v1.ContentServiceClient()
# Initialize request argument(s)
request = dataplex_v1.ListContentRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_content(request=request)
# Handle the response
for response in page_result:
print(response)
Name | Description |
request |
Union[google.cloud.dataplex_v1.types.ListContentRequest, dict]
The request object. List content request. Returns the BASIC Content view. |
parent |
`str`
Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id} 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. |
Type | Description |
google.cloud.dataplex_v1.services.content_service.pagers.ListContentAsyncPager | List content 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_content_path
parse_content_path(path: str)
Parses a content path into its component segments.
parse_lake_path
parse_lake_path(path: str)
Parses a lake path into its component segments.
update_content
update_content(request: Optional[Union[google.cloud.dataplex_v1.types.content.UpdateContentRequest, dict]] = None, *, content: Optional[google.cloud.dataplex_v1.types.analyze.Content] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = 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 content. Only supports full resource update.
from google.cloud import dataplex_v1
def sample_update_content():
# Create a client
client = dataplex_v1.ContentServiceClient()
# Initialize request argument(s)
content = dataplex_v1.Content()
content.data_text = "data_text_value"
content.sql_script.engine = "SPARK"
content.path = "path_value"
request = dataplex_v1.UpdateContentRequest(
content=content,
)
# Make the request
response = client.update_content(request=request)
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.dataplex_v1.types.UpdateContentRequest, dict]
The request object. Update content request. |
content |
Content
Required. Update description. Only fields specified in |
update_mask |
`google.protobuf.field_mask_pb2.FieldMask`
Required. Mask of fields to update. 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. |
Type | Description |
google.cloud.dataplex_v1.types.Content | Content represents a user-visible notebook or a sql script |