Class DocumentSchemaServiceAsyncClient (0.4.1)

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

This service lets you manage document schema.

Properties

transport

Returns the transport used by the client instance.

Returns
Type	Description
`DocumentSchemaServiceTransport`	The transport used by the client instance.

Methods

DocumentSchemaServiceAsyncClient

DocumentSchemaServiceAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.contentwarehouse_v1.services.document_schema_service.transports.base.DocumentSchemaServiceTransport] = '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 document schema 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, .DocumentSchemaServiceTransport]` 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

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_document_schema

create_document_schema(request: Optional[Union[google.cloud.contentwarehouse_v1.types.document_schema_service.CreateDocumentSchemaRequest, dict]] = None, *, parent: Optional[str] = None, document_schema: Optional[google.cloud.contentwarehouse_v1.types.document_schema.DocumentSchema] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())

Creates a document schema.

# 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_schema():
    # Create a client
    client = contentwarehouse_v1.DocumentSchemaServiceAsyncClient()

    # Initialize request argument(s)
    document_schema = contentwarehouse_v1.DocumentSchema()
    document_schema.display_name = "display_name_value"

    request = contentwarehouse_v1.CreateDocumentSchemaRequest(
        parent="parent_value",
        document_schema=document_schema,
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Optional[Union[google.cloud.contentwarehouse_v1.types.CreateDocumentSchemaRequest, dict]]` The request object. Request message for DocumentSchemaService.CreateDocumentSchema.
`parent`	`str` Required. The parent name. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`document_schema`	`DocumentSchema` Required. The document schema to create. This corresponds to the `document_schema` 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.DocumentSchema`	A document schema used to define document structure.

delete_document_schema

delete_document_schema(request: Optional[Union[google.cloud.contentwarehouse_v1.types.document_schema_service.DeleteDocumentSchemaRequest, 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: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())

Deletes a document schema. Returns NOT_FOUND if the document schema does not exist. Returns BAD_REQUEST if the document schema has documents depending on it.

# 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_schema():
    # Create a client
    client = contentwarehouse_v1.DocumentSchemaServiceAsyncClient()

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

    # Make the request
    await client.delete_document_schema(request=request)

Parameters
Name	Description
`request`	`Optional[Union[google.cloud.contentwarehouse_v1.types.DeleteDocumentSchemaRequest, dict]]` The request object. Request message for DocumentSchemaService.DeleteDocumentSchema.
`name`	`str` Required. The name of the document schema to delete. 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_schema_path

document_schema_path(project: str, location: str, document_schema: str)

Returns a fully-qualified document_schema 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
`DocumentSchemaServiceAsyncClient`	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
`DocumentSchemaServiceAsyncClient`	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
`DocumentSchemaServiceAsyncClient`	The constructed client.

get_document_schema

get_document_schema(request: Optional[Union[google.cloud.contentwarehouse_v1.types.document_schema_service.GetDocumentSchemaRequest, 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: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())

Gets a document schema. Returns NOT_FOUND if the document schema does not exist.

# 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_get_document_schema():
    # Create a client
    client = contentwarehouse_v1.DocumentSchemaServiceAsyncClient()

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

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Optional[Union[google.cloud.contentwarehouse_v1.types.GetDocumentSchemaRequest, dict]]` The request object. Request message for DocumentSchemaService.GetDocumentSchema.
`name`	`str` Required. The name of the document schema to retrieve. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.contentwarehouse_v1.types.DocumentSchema`	A document schema used to define document structure.

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 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_transport_class

get_transport_class()

Returns an appropriate transport class.

list_document_schemas

list_document_schemas(request: Optional[Union[google.cloud.contentwarehouse_v1.types.document_schema_service.ListDocumentSchemasRequest, 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: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())

Lists document schemas.

# 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_document_schemas():
    # Create a client
    client = contentwarehouse_v1.DocumentSchemaServiceAsyncClient()

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

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

    # Handle the response
    async for response in page_result:
        print(response)

Parameters
Name	Description
`request`	`Optional[Union[google.cloud.contentwarehouse_v1.types.ListDocumentSchemasRequest, dict]]` The request object. Request message for DocumentSchemaService.ListDocumentSchemas.
`parent`	`str` Required. The parent, which owns this collection of document schemas. Format: projects/{project_number}/locations/{location}. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.contentwarehouse_v1.services.document_schema_service.pagers.ListDocumentSchemasAsyncPager`	Response message for DocumentSchemaService.ListDocumentSchemas. Iterating over this object will yield results and resolve additional pages automatically.

location_path

location_path(project: str, location: str)

Returns a fully-qualified location string.

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_document_schema_path

parse_document_schema_path(path: str)

Parses a document_schema path into its component segments.

parse_location_path

parse_location_path(path: str)

Parses a location path into its component segments.

update_document_schema

update_document_schema(request: Optional[Union[google.cloud.contentwarehouse_v1.types.document_schema_service.UpdateDocumentSchemaRequest, dict]] = None, *, name: Optional[str] = None, document_schema: Optional[google.cloud.contentwarehouse_v1.types.document_schema.DocumentSchema] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())

Updates a Document Schema. Returns INVALID_ARGUMENT if the name of the Document Schema is non-empty and does not equal the existing name. Supports only appending new properties, adding new ENUM possible values, and updating the xref_EnumTypeOptions.validation_check_disabled flag for ENUM possible values. Updating existing properties will result into INVALID_ARGUMENT.

# 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_update_document_schema():
    # Create a client
    client = contentwarehouse_v1.DocumentSchemaServiceAsyncClient()

    # Initialize request argument(s)
    document_schema = contentwarehouse_v1.DocumentSchema()
    document_schema.display_name = "display_name_value"

    request = contentwarehouse_v1.UpdateDocumentSchemaRequest(
        name="name_value",
        document_schema=document_schema,
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Optional[Union[google.cloud.contentwarehouse_v1.types.UpdateDocumentSchemaRequest, dict]]` The request object. Request message for DocumentSchemaService.UpdateDocumentSchema.
`name`	`str` Required. The name of the document schema to update. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`document_schema`	`DocumentSchema` Required. The document schema to update with. This corresponds to the `document_schema` 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.DocumentSchema`	A document schema used to define document structure.