Class DocumentLinkServiceAsyncClient (0.5.1) 

DocumentLinkServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.contentwarehouse_v1.services.document_link_service.transports.base.DocumentLinkServiceTransport] = '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>)

This service lets you manage document-links. Document-Links are treated as sub-resources under source documents.

Properties

Returns the transport used by the client instance.

Returns
Type Description
DocumentLinkServiceTransport The transport used by the client instance.

Methods 

DocumentLinkServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.contentwarehouse_v1.services.document_link_service.transports.base.DocumentLinkServiceTransport] = '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 document link 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, .DocumentLinkServiceTransport]

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_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used.
Exceptions
Type Description
google.auth.exceptions.MutualTlsChannelError If mutual TLS transport creation failed for any reason. 
common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

common_project_path(project: str) -> str

Returns a fully-qualified project string.

create_document_link(
    request: typing.Optional[
        typing.Union[
            google.cloud.contentwarehouse_v1.types.document_link_service.CreateDocumentLinkRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    document_link: typing.Optional[
        google.cloud.contentwarehouse_v1.types.document_link_service.DocumentLink
    ] = 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.contentwarehouse_v1.types.document_link_service.DocumentLink

Create a link between a source document and a target document.

# 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 contentwarehouse_v1

async def sample_create_document_link():
    # Create a client
    client = contentwarehouse_v1.DocumentLinkServiceAsyncClient()

    # Initialize request argument(s)
    request = contentwarehouse_v1.CreateDocumentLinkRequest(
        parent="parent_value",
    )

    # Make the request
    response = await client.create_document_link(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Optional[Union[google.cloud.contentwarehouse_v1.types.CreateDocumentLinkRequest, dict]]

The request object. Request message for DocumentLinkService.CreateDocumentLink.
parent str

Required. Parent of the document-link to be created. parent of document-link should be a document. Format: projects/{project_number}/locations/{location}/documents/{source_document_id}. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
document_link DocumentLink

Required. Document links associated with the source documents (source_document_id). This corresponds to the document_link 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
Type Description
google.cloud.contentwarehouse_v1.types.DocumentLink A document-link between source and target document. 
delete_document_link(
    request: typing.Optional[
        typing.Union[
            google.cloud.contentwarehouse_v1.types.document_link_service.DeleteDocumentLinkRequest,
            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

Remove the link between the source and target documents.

# 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 contentwarehouse_v1

async def sample_delete_document_link():
    # Create a client
    client = contentwarehouse_v1.DocumentLinkServiceAsyncClient()

    # Initialize request argument(s)
    request = contentwarehouse_v1.DeleteDocumentLinkRequest(
        name="name_value",
    )

    # Make the request
    await client.delete_document_link(request=request)
Parameters
Name Description
request Optional[Union[google.cloud.contentwarehouse_v1.types.DeleteDocumentLinkRequest, dict]]

The request object. Request message for DocumentLinkService.DeleteDocumentLink.
name str

Required. The name of the document-link to be deleted. Format: projects/{project_number}/locations/{location}/documents/{source_document_id}/documentLinks/{document_link_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.

 
document_link_path(
    project: str, location: str, document: str, document_link: str
) -> str

Returns a fully-qualified document_link string.

document_path(project: str, location: str, document: str) -> str

Returns a fully-qualified document string.

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
DocumentLinkServiceAsyncClient The constructed client. 
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
DocumentLinkServiceAsyncClient The constructed client. 
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
DocumentLinkServiceAsyncClient The constructed client. 
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 api_endpoint and client_cert_source properties may be used in this method.
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(
    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 .operations_pb2.GetOperationRequest

The request object. Request message for GetOperation 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
.operations_pb2.Operation An Operation object. 
get_transport_class() -> (
    typing.Type[
        google.cloud.contentwarehouse_v1.services.document_link_service.transports.base.DocumentLinkServiceTransport
    ]
)

Returns an appropriate transport class.

list_linked_sources(
    request: typing.Optional[
        typing.Union[
            google.cloud.contentwarehouse_v1.types.document_link_service.ListLinkedSourcesRequest,
            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.contentwarehouse_v1.services.document_link_service.pagers.ListLinkedSourcesAsyncPager
)

Return all source document-links from the document.

# 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 contentwarehouse_v1

async def sample_list_linked_sources():
    # Create a client
    client = contentwarehouse_v1.DocumentLinkServiceAsyncClient()

    # Initialize request argument(s)
    request = contentwarehouse_v1.ListLinkedSourcesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_linked_sources(request=request)

    # Handle the response
    async for response in page_result:
        print(response)
Parameters
Name Description
request Optional[Union[google.cloud.contentwarehouse_v1.types.ListLinkedSourcesRequest, dict]]

The request object. Response message for DocumentLinkService.ListLinkedSources.
parent str

Required. The name of the document, for which all source links are returned. Format: projects/{project_number}/locations/{location}/documents/{source_document_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
Type Description
google.cloud.contentwarehouse_v1.services.document_link_service.pagers.ListLinkedSourcesAsyncPager Response message for DocumentLinkService.ListLinkedSources. Iterating over this object will yield results and resolve additional pages automatically. 
list_linked_targets(
    request: typing.Optional[
        typing.Union[
            google.cloud.contentwarehouse_v1.types.document_link_service.ListLinkedTargetsRequest,
            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.contentwarehouse_v1.types.document_link_service.ListLinkedTargetsResponse
)

Return all target document-links from the document.

# 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 contentwarehouse_v1

async def sample_list_linked_targets():
    # Create a client
    client = contentwarehouse_v1.DocumentLinkServiceAsyncClient()

    # Initialize request argument(s)
    request = contentwarehouse_v1.ListLinkedTargetsRequest(
        parent="parent_value",
    )

    # Make the request
    response = await client.list_linked_targets(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Optional[Union[google.cloud.contentwarehouse_v1.types.ListLinkedTargetsRequest, dict]]

The request object. Request message for DocumentLinkService.ListLinkedTargets.
parent str

Required. The name of the document, for which all target links are returned. Format: projects/{project_number}/locations/{location}/documents/{target_document_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
Type Description
google.cloud.contentwarehouse_v1.types.ListLinkedTargetsResponse Response message for DocumentLinkService.ListLinkedTargets. 
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

parse_document_link_path(path: str) -> typing.Dict[str, str]

Parses a document_link path into its component segments.

parse_document_path(path: str) -> typing.Dict[str, str]

Parses a document path into its component segments.