Package Methods (0.7.8)

Summary of entries of Methods for contentwarehouse.

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

Instantiates the document link service async client.

See more: google.cloud.contentwarehouse_v1.services.document_link_service.DocumentLinkServiceAsyncClient

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.contentwarehouse_v1.services.document_link_service.DocumentLinkServiceAsyncClient.common_billing_account_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.contentwarehouse_v1.services.document_link_service.DocumentLinkServiceAsyncClient.common_folder_path

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

Returns a fully-qualified location string.

See more: google.cloud.contentwarehouse_v1.services.document_link_service.DocumentLinkServiceAsyncClient.common_location_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.contentwarehouse_v1.services.document_link_service.DocumentLinkServiceAsyncClient.common_organization_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.contentwarehouse_v1.services.document_link_service.DocumentLinkServiceAsyncClient.common_project_path

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.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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.

See more: google.cloud.contentwarehouse_v1.services.document_link_service.DocumentLinkServiceAsyncClient.create_document_link

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.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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.

See more: google.cloud.contentwarehouse_v1.services.document_link_service.DocumentLinkServiceAsyncClient.delete_document_link

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

Returns a fully-qualified document_link string.

See more: google.cloud.contentwarehouse_v1.services.document_link_service.DocumentLinkServiceAsyncClient.document_link_path

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

Returns a fully-qualified document string.

See more: google.cloud.contentwarehouse_v1.services.document_link_service.DocumentLinkServiceAsyncClient.document_path

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.contentwarehouse_v1.services.document_link_service.DocumentLinkServiceAsyncClient.from_service_account_file

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

See more: google.cloud.contentwarehouse_v1.services.document_link_service.DocumentLinkServiceAsyncClient.from_service_account_info

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.contentwarehouse_v1.services.document_link_service.DocumentLinkServiceAsyncClient.from_service_account_json

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.

See more: google.cloud.contentwarehouse_v1.services.document_link_service.DocumentLinkServiceAsyncClient.get_mtls_endpoint_and_cert_source

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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.

See more: google.cloud.contentwarehouse_v1.services.document_link_service.DocumentLinkServiceAsyncClient.get_operation

get_transport_class() -> (
    typing.Type[
        google.cloud.contentwarehouse_v1.services.document_link_service.transports.base.DocumentLinkServiceTransport
    ]
)

Returns an appropriate transport class.

See more: google.cloud.contentwarehouse_v1.services.document_link_service.DocumentLinkServiceAsyncClient.get_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.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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.

See more: google.cloud.contentwarehouse_v1.services.document_link_service.DocumentLinkServiceAsyncClient.list_linked_sources

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.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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.

See more: google.cloud.contentwarehouse_v1.services.document_link_service.DocumentLinkServiceAsyncClient.list_linked_targets

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

Parse a billing_account path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.document_link_service.DocumentLinkServiceAsyncClient.parse_common_billing_account_path

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

Parse a folder path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.document_link_service.DocumentLinkServiceAsyncClient.parse_common_folder_path

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

Parse a location path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.document_link_service.DocumentLinkServiceAsyncClient.parse_common_location_path

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

Parse a organization path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.document_link_service.DocumentLinkServiceAsyncClient.parse_common_organization_path

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

Parse a project path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.document_link_service.DocumentLinkServiceAsyncClient.parse_common_project_path

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

Parses a document_link path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.document_link_service.DocumentLinkServiceAsyncClient.parse_document_link_path

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

Parses a document path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.document_link_service.DocumentLinkServiceAsyncClient.parse_document_path

DocumentLinkServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.contentwarehouse_v1.services.document_link_service.transports.base.DocumentLinkServiceTransport, typing.Callable[[...], google.cloud.contentwarehouse_v1.services.document_link_service.transports.base.DocumentLinkServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the document link service client.

See more: google.cloud.contentwarehouse_v1.services.document_link_service.DocumentLinkServiceClient

google.cloud.contentwarehouse_v1.services.document_link_service.DocumentLinkServiceClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.contentwarehouse_v1.services.document_link_service.DocumentLinkServiceClient.exit

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.contentwarehouse_v1.services.document_link_service.DocumentLinkServiceClient.common_billing_account_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.contentwarehouse_v1.services.document_link_service.DocumentLinkServiceClient.common_folder_path

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

Returns a fully-qualified location string.

See more: google.cloud.contentwarehouse_v1.services.document_link_service.DocumentLinkServiceClient.common_location_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.contentwarehouse_v1.services.document_link_service.DocumentLinkServiceClient.common_organization_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.contentwarehouse_v1.services.document_link_service.DocumentLinkServiceClient.common_project_path

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.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.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.

See more: google.cloud.contentwarehouse_v1.services.document_link_service.DocumentLinkServiceClient.create_document_link

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.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.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.

See more: google.cloud.contentwarehouse_v1.services.document_link_service.DocumentLinkServiceClient.delete_document_link

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

Returns a fully-qualified document_link string.

See more: google.cloud.contentwarehouse_v1.services.document_link_service.DocumentLinkServiceClient.document_link_path

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

Returns a fully-qualified document string.

See more: google.cloud.contentwarehouse_v1.services.document_link_service.DocumentLinkServiceClient.document_path

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.contentwarehouse_v1.services.document_link_service.DocumentLinkServiceClient.from_service_account_file

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

See more: google.cloud.contentwarehouse_v1.services.document_link_service.DocumentLinkServiceClient.from_service_account_info

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.contentwarehouse_v1.services.document_link_service.DocumentLinkServiceClient.from_service_account_json

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated.

See more: google.cloud.contentwarehouse_v1.services.document_link_service.DocumentLinkServiceClient.get_mtls_endpoint_and_cert_source

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.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.

See more: google.cloud.contentwarehouse_v1.services.document_link_service.DocumentLinkServiceClient.get_operation

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.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.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.ListLinkedSourcesPager
)

Return all source document-links from the document.

See more: google.cloud.contentwarehouse_v1.services.document_link_service.DocumentLinkServiceClient.list_linked_sources

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.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.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.

See more: google.cloud.contentwarehouse_v1.services.document_link_service.DocumentLinkServiceClient.list_linked_targets

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

Parse a billing_account path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.document_link_service.DocumentLinkServiceClient.parse_common_billing_account_path

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

Parse a folder path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.document_link_service.DocumentLinkServiceClient.parse_common_folder_path

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

Parse a location path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.document_link_service.DocumentLinkServiceClient.parse_common_location_path

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

Parse a organization path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.document_link_service.DocumentLinkServiceClient.parse_common_organization_path

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

Parse a project path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.document_link_service.DocumentLinkServiceClient.parse_common_project_path

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

Parses a document_link path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.document_link_service.DocumentLinkServiceClient.parse_document_link_path

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

Parses a document path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.document_link_service.DocumentLinkServiceClient.parse_document_path

ListLinkedSourcesAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.contentwarehouse_v1.types.document_link_service.ListLinkedSourcesResponse
        ],
    ],
    request: google.cloud.contentwarehouse_v1.types.document_link_service.ListLinkedSourcesRequest,
    response: google.cloud.contentwarehouse_v1.types.document_link_service.ListLinkedSourcesResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiates the pager.

See more: google.cloud.contentwarehouse_v1.services.document_link_service.pagers.ListLinkedSourcesAsyncPager

ListLinkedSourcesPager(
    method: typing.Callable[
        [...],
        google.cloud.contentwarehouse_v1.types.document_link_service.ListLinkedSourcesResponse,
    ],
    request: google.cloud.contentwarehouse_v1.types.document_link_service.ListLinkedSourcesRequest,
    response: google.cloud.contentwarehouse_v1.types.document_link_service.ListLinkedSourcesResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiate the pager.

See more: google.cloud.contentwarehouse_v1.services.document_link_service.pagers.ListLinkedSourcesPager

google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceAsyncClient

DocumentSchemaServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.contentwarehouse_v1.services.document_schema_service.transports.base.DocumentSchemaServiceTransport, typing.Callable[[...], google.cloud.contentwarehouse_v1.services.document_schema_service.transports.base.DocumentSchemaServiceTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the document schema service async client.

See more: google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceAsyncClient

google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceAsyncClient.common_billing_account_path

google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceAsyncClient.common_folder_path

google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceAsyncClient.common_location_path

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

Returns a fully-qualified location string.

See more: google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceAsyncClient.common_location_path

google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceAsyncClient.common_organization_path

google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceAsyncClient.common_project_path

google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceAsyncClient.create_document_schema

create_document_schema(
    request: typing.Optional[
        typing.Union[
            google.cloud.contentwarehouse_v1.types.document_schema_service.CreateDocumentSchemaRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    document_schema: typing.Optional[
        google.cloud.contentwarehouse_v1.types.document_schema.DocumentSchema
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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_schema.DocumentSchema

Creates a document schema.

See more: google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceAsyncClient.create_document_schema

google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceAsyncClient.delete_document_schema

delete_document_schema(
    request: typing.Optional[
        typing.Union[
            google.cloud.contentwarehouse_v1.types.document_schema_service.DeleteDocumentSchemaRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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 document schema.

See more: google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceAsyncClient.delete_document_schema

google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceAsyncClient.document_schema_path

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

Returns a fully-qualified document_schema string.

See more: google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceAsyncClient.document_schema_path

google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceAsyncClient.from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceAsyncClient.from_service_account_file

google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceAsyncClient.from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

See more: google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceAsyncClient.from_service_account_info

google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceAsyncClient.from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceAsyncClient.from_service_account_json

google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceAsyncClient.get_document_schema

get_document_schema(
    request: typing.Optional[
        typing.Union[
            google.cloud.contentwarehouse_v1.types.document_schema_service.GetDocumentSchemaRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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_schema.DocumentSchema

Gets a document schema.

See more: google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceAsyncClient.get_document_schema

google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceAsyncClient.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.

See more: google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceAsyncClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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.

See more: google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceAsyncClient.get_operation

google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceAsyncClient.get_transport_class

get_transport_class() -> (
    typing.Type[
        google.cloud.contentwarehouse_v1.services.document_schema_service.transports.base.DocumentSchemaServiceTransport
    ]
)

Returns an appropriate transport class.

See more: google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceAsyncClient.get_transport_class

google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceAsyncClient.list_document_schemas

list_document_schemas(
    request: typing.Optional[
        typing.Union[
            google.cloud.contentwarehouse_v1.types.document_schema_service.ListDocumentSchemasRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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_schema_service.pagers.ListDocumentSchemasAsyncPager
)

Lists document schemas.

See more: google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceAsyncClient.list_document_schemas

google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceAsyncClient.location_path

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

Returns a fully-qualified location string.

See more: google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceAsyncClient.location_path

google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceAsyncClient.parse_common_billing_account_path

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

Parse a billing_account path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceAsyncClient.parse_common_billing_account_path

google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceAsyncClient.parse_common_folder_path

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

Parse a folder path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceAsyncClient.parse_common_folder_path

google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceAsyncClient.parse_common_location_path

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

Parse a location path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceAsyncClient.parse_common_location_path

google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceAsyncClient.parse_common_organization_path

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

Parse a organization path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceAsyncClient.parse_common_organization_path

google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceAsyncClient.parse_common_project_path

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

Parse a project path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceAsyncClient.parse_common_project_path

google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceAsyncClient.parse_document_schema_path

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

Parses a document_schema path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceAsyncClient.parse_document_schema_path

google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceAsyncClient.parse_location_path

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

Parses a location path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceAsyncClient.parse_location_path

google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceAsyncClient.update_document_schema

update_document_schema(
    request: typing.Optional[
        typing.Union[
            google.cloud.contentwarehouse_v1.types.document_schema_service.UpdateDocumentSchemaRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    document_schema: typing.Optional[
        google.cloud.contentwarehouse_v1.types.document_schema.DocumentSchema
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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_schema.DocumentSchema

Updates a Document Schema.

See more: google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceAsyncClient.update_document_schema

google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceClient

DocumentSchemaServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.contentwarehouse_v1.services.document_schema_service.transports.base.DocumentSchemaServiceTransport, typing.Callable[[...], google.cloud.contentwarehouse_v1.services.document_schema_service.transports.base.DocumentSchemaServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the document schema service client.

See more: google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceClient

google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceClient.exit

google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceClient.common_billing_account_path

google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceClient.common_folder_path

google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceClient.common_location_path

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

Returns a fully-qualified location string.

See more: google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceClient.common_location_path

google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceClient.common_organization_path

google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceClient.common_project_path

google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceClient.create_document_schema

create_document_schema(
    request: typing.Optional[
        typing.Union[
            google.cloud.contentwarehouse_v1.types.document_schema_service.CreateDocumentSchemaRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    document_schema: typing.Optional[
        google.cloud.contentwarehouse_v1.types.document_schema.DocumentSchema
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.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_schema.DocumentSchema

Creates a document schema.

See more: google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceClient.create_document_schema

google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceClient.delete_document_schema

delete_document_schema(
    request: typing.Optional[
        typing.Union[
            google.cloud.contentwarehouse_v1.types.document_schema_service.DeleteDocumentSchemaRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.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 document schema.

See more: google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceClient.delete_document_schema

google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceClient.document_schema_path

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

Returns a fully-qualified document_schema string.

See more: google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceClient.document_schema_path

google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceClient.from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceClient.from_service_account_file

google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceClient.from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

See more: google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceClient.from_service_account_info

google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceClient.from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceClient.from_service_account_json

google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceClient.get_document_schema

get_document_schema(
    request: typing.Optional[
        typing.Union[
            google.cloud.contentwarehouse_v1.types.document_schema_service.GetDocumentSchemaRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.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_schema.DocumentSchema

Gets a document schema.

See more: google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceClient.get_document_schema

google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated.

See more: google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceClient.get_mtls_endpoint_and_cert_source

google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.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.

See more: google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceClient.get_operation

google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceClient.list_document_schemas

list_document_schemas(
    request: typing.Optional[
        typing.Union[
            google.cloud.contentwarehouse_v1.types.document_schema_service.ListDocumentSchemasRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.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_schema_service.pagers.ListDocumentSchemasPager
)

Lists document schemas.

See more: google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceClient.list_document_schemas

google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceClient.location_path

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

Returns a fully-qualified location string.

See more: google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceClient.location_path

google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceClient.parse_common_billing_account_path

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

Parse a billing_account path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceClient.parse_common_billing_account_path

google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceClient.parse_common_folder_path

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

Parse a folder path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceClient.parse_common_folder_path

google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceClient.parse_common_location_path

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

Parse a location path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceClient.parse_common_location_path

google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceClient.parse_common_organization_path

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

Parse a organization path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceClient.parse_common_organization_path

google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceClient.parse_common_project_path

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

Parse a project path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceClient.parse_common_project_path

google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceClient.parse_document_schema_path

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

Parses a document_schema path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceClient.parse_document_schema_path

google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceClient.parse_location_path

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

Parses a location path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceClient.parse_location_path

google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceClient.update_document_schema

update_document_schema(
    request: typing.Optional[
        typing.Union[
            google.cloud.contentwarehouse_v1.types.document_schema_service.UpdateDocumentSchemaRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    document_schema: typing.Optional[
        google.cloud.contentwarehouse_v1.types.document_schema.DocumentSchema
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.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_schema.DocumentSchema

Updates a Document Schema.

See more: google.cloud.contentwarehouse_v1.services.document_schema_service.DocumentSchemaServiceClient.update_document_schema

google.cloud.contentwarehouse_v1.services.document_schema_service.pagers.ListDocumentSchemasAsyncPager

ListDocumentSchemasAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.contentwarehouse_v1.types.document_schema_service.ListDocumentSchemasResponse
        ],
    ],
    request: google.cloud.contentwarehouse_v1.types.document_schema_service.ListDocumentSchemasRequest,
    response: google.cloud.contentwarehouse_v1.types.document_schema_service.ListDocumentSchemasResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiates the pager.

See more: google.cloud.contentwarehouse_v1.services.document_schema_service.pagers.ListDocumentSchemasAsyncPager

google.cloud.contentwarehouse_v1.services.document_schema_service.pagers.ListDocumentSchemasPager

ListDocumentSchemasPager(
    method: typing.Callable[
        [...],
        google.cloud.contentwarehouse_v1.types.document_schema_service.ListDocumentSchemasResponse,
    ],
    request: google.cloud.contentwarehouse_v1.types.document_schema_service.ListDocumentSchemasRequest,
    response: google.cloud.contentwarehouse_v1.types.document_schema_service.ListDocumentSchemasResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiate the pager.

See more: google.cloud.contentwarehouse_v1.services.document_schema_service.pagers.ListDocumentSchemasPager

google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceAsyncClient

DocumentServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.contentwarehouse_v1.services.document_service.transports.base.DocumentServiceTransport, typing.Callable[[...], google.cloud.contentwarehouse_v1.services.document_service.transports.base.DocumentServiceTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the document service async client.

See more: google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceAsyncClient

google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceAsyncClient.common_billing_account_path

google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceAsyncClient.common_folder_path

google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceAsyncClient.common_location_path

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

Returns a fully-qualified location string.

See more: google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceAsyncClient.common_location_path

google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceAsyncClient.common_organization_path

google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceAsyncClient.common_project_path

google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceAsyncClient.create_document

create_document(
    request: typing.Optional[
        typing.Union[
            google.cloud.contentwarehouse_v1.types.document_service_request.CreateDocumentRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    document: typing.Optional[
        google.cloud.contentwarehouse_v1.types.document.Document
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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_service.CreateDocumentResponse

Creates a document.

See more: google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceAsyncClient.create_document

google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceAsyncClient.delete_document

delete_document(
    request: typing.Optional[
        typing.Union[
            google.cloud.contentwarehouse_v1.types.document_service_request.DeleteDocumentRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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 document.

See more: google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceAsyncClient.delete_document

google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceAsyncClient.document_path

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

Returns a fully-qualified document string.

See more: google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceAsyncClient.document_path

google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceAsyncClient.document_schema_path

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

Returns a fully-qualified document_schema string.

See more: google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceAsyncClient.document_schema_path

google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceAsyncClient.fetch_acl

fetch_acl(
    request: typing.Optional[
        typing.Union[
            google.cloud.contentwarehouse_v1.types.document_service_request.FetchAclRequest,
            dict,
        ]
    ] = None,
    *,
    resource: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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_service.FetchAclResponse

Gets the access control policy for a resource.

See more: google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceAsyncClient.fetch_acl

google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceAsyncClient.from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceAsyncClient.from_service_account_file

google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceAsyncClient.from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

See more: google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceAsyncClient.from_service_account_info

google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceAsyncClient.from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceAsyncClient.from_service_account_json

google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceAsyncClient.get_document

get_document(
    request: typing.Optional[
        typing.Union[
            google.cloud.contentwarehouse_v1.types.document_service_request.GetDocumentRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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.Document

Gets a document.

See more: google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceAsyncClient.get_document

google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceAsyncClient.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.

See more: google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceAsyncClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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.

See more: google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceAsyncClient.get_operation

google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceAsyncClient.get_transport_class

get_transport_class() -> (
    typing.Type[
        google.cloud.contentwarehouse_v1.services.document_service.transports.base.DocumentServiceTransport
    ]
)

Returns an appropriate transport class.

See more: google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceAsyncClient.get_transport_class

google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceAsyncClient.location_path

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

Returns a fully-qualified location string.

See more: google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceAsyncClient.location_path

google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceAsyncClient.lock_document

lock_document(
    request: typing.Optional[
        typing.Union[
            google.cloud.contentwarehouse_v1.types.document_service_request.LockDocumentRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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.Document

Lock the document so the document cannot be updated by other users.

See more: google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceAsyncClient.lock_document

google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceAsyncClient.parse_common_billing_account_path

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

Parse a billing_account path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceAsyncClient.parse_common_billing_account_path

google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceAsyncClient.parse_common_folder_path

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

Parse a folder path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceAsyncClient.parse_common_folder_path

google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceAsyncClient.parse_common_location_path

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

Parse a location path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceAsyncClient.parse_common_location_path

google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceAsyncClient.parse_common_organization_path

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

Parse a organization path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceAsyncClient.parse_common_organization_path

google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceAsyncClient.parse_common_project_path

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

Parse a project path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceAsyncClient.parse_common_project_path

google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceAsyncClient.parse_document_path

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

Parses a document path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceAsyncClient.parse_document_path

google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceAsyncClient.parse_document_schema_path

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

Parses a document_schema path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceAsyncClient.parse_document_schema_path

google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceAsyncClient.parse_location_path

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

Parses a location path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceAsyncClient.parse_location_path

google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceAsyncClient.search_documents

search_documents(
    request: typing.Optional[
        typing.Union[
            google.cloud.contentwarehouse_v1.types.document_service_request.SearchDocumentsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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_service.pagers.SearchDocumentsAsyncPager
)

Searches for documents using provided xref_SearchDocumentsRequest.

See more: google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceAsyncClient.search_documents

google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceAsyncClient.set_acl

set_acl(
    request: typing.Optional[
        typing.Union[
            google.cloud.contentwarehouse_v1.types.document_service_request.SetAclRequest,
            dict,
        ]
    ] = None,
    *,
    resource: typing.Optional[str] = None,
    policy: typing.Optional[google.iam.v1.policy_pb2.Policy] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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_service.SetAclResponse

Sets the access control policy for a resource.

See more: google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceAsyncClient.set_acl

google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceAsyncClient.update_document

update_document(
    request: typing.Optional[
        typing.Union[
            google.cloud.contentwarehouse_v1.types.document_service_request.UpdateDocumentRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    document: typing.Optional[
        google.cloud.contentwarehouse_v1.types.document.Document
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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_service.UpdateDocumentResponse

Updates a document.

See more: google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceAsyncClient.update_document

google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceClient

DocumentServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.contentwarehouse_v1.services.document_service.transports.base.DocumentServiceTransport, typing.Callable[[...], google.cloud.contentwarehouse_v1.services.document_service.transports.base.DocumentServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the document service client.

See more: google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceClient

google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceClient.exit

google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceClient.common_billing_account_path

google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceClient.common_folder_path

google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceClient.common_location_path

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

Returns a fully-qualified location string.

See more: google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceClient.common_location_path

google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceClient.common_organization_path

google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceClient.common_project_path

google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceClient.create_document

create_document(
    request: typing.Optional[
        typing.Union[
            google.cloud.contentwarehouse_v1.types.document_service_request.CreateDocumentRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    document: typing.Optional[
        google.cloud.contentwarehouse_v1.types.document.Document
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.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_service.CreateDocumentResponse

Creates a document.

See more: google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceClient.create_document

google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceClient.delete_document

delete_document(
    request: typing.Optional[
        typing.Union[
            google.cloud.contentwarehouse_v1.types.document_service_request.DeleteDocumentRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.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 document.

See more: google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceClient.delete_document

google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceClient.document_path

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

Returns a fully-qualified document string.

See more: google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceClient.document_path

google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceClient.document_schema_path

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

Returns a fully-qualified document_schema string.

See more: google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceClient.document_schema_path

google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceClient.fetch_acl

fetch_acl(
    request: typing.Optional[
        typing.Union[
            google.cloud.contentwarehouse_v1.types.document_service_request.FetchAclRequest,
            dict,
        ]
    ] = None,
    *,
    resource: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.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_service.FetchAclResponse

Gets the access control policy for a resource.

See more: google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceClient.fetch_acl

google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceClient.from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceClient.from_service_account_file

google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceClient.from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

See more: google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceClient.from_service_account_info

google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceClient.from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceClient.from_service_account_json

google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceClient.get_document

get_document(
    request: typing.Optional[
        typing.Union[
            google.cloud.contentwarehouse_v1.types.document_service_request.GetDocumentRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.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.Document

Gets a document.

See more: google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceClient.get_document

google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated.

See more: google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceClient.get_mtls_endpoint_and_cert_source

google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.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.

See more: google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceClient.get_operation

google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceClient.location_path

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

Returns a fully-qualified location string.

See more: google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceClient.location_path

google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceClient.lock_document

lock_document(
    request: typing.Optional[
        typing.Union[
            google.cloud.contentwarehouse_v1.types.document_service_request.LockDocumentRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.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.Document

Lock the document so the document cannot be updated by other users.

See more: google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceClient.lock_document

google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceClient.parse_common_billing_account_path

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

Parse a billing_account path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceClient.parse_common_billing_account_path

google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceClient.parse_common_folder_path

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

Parse a folder path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceClient.parse_common_folder_path

google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceClient.parse_common_location_path

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

Parse a location path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceClient.parse_common_location_path

google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceClient.parse_common_organization_path

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

Parse a organization path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceClient.parse_common_organization_path

google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceClient.parse_common_project_path

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

Parse a project path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceClient.parse_common_project_path

google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceClient.parse_document_path

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

Parses a document path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceClient.parse_document_path

google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceClient.parse_document_schema_path

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

Parses a document_schema path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceClient.parse_document_schema_path

google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceClient.parse_location_path

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

Parses a location path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceClient.parse_location_path

google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceClient.search_documents

search_documents(
    request: typing.Optional[
        typing.Union[
            google.cloud.contentwarehouse_v1.types.document_service_request.SearchDocumentsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.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_service.pagers.SearchDocumentsPager
)

Searches for documents using provided xref_SearchDocumentsRequest.

See more: google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceClient.search_documents

google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceClient.set_acl

set_acl(
    request: typing.Optional[
        typing.Union[
            google.cloud.contentwarehouse_v1.types.document_service_request.SetAclRequest,
            dict,
        ]
    ] = None,
    *,
    resource: typing.Optional[str] = None,
    policy: typing.Optional[google.iam.v1.policy_pb2.Policy] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.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_service.SetAclResponse

Sets the access control policy for a resource.

See more: google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceClient.set_acl

google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceClient.update_document

update_document(
    request: typing.Optional[
        typing.Union[
            google.cloud.contentwarehouse_v1.types.document_service_request.UpdateDocumentRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    document: typing.Optional[
        google.cloud.contentwarehouse_v1.types.document.Document
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.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_service.UpdateDocumentResponse

Updates a document.

See more: google.cloud.contentwarehouse_v1.services.document_service.DocumentServiceClient.update_document

google.cloud.contentwarehouse_v1.services.document_service.pagers.SearchDocumentsAsyncPager

SearchDocumentsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.contentwarehouse_v1.types.document_service.SearchDocumentsResponse
        ],
    ],
    request: google.cloud.contentwarehouse_v1.types.document_service_request.SearchDocumentsRequest,
    response: google.cloud.contentwarehouse_v1.types.document_service.SearchDocumentsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiates the pager.

See more: google.cloud.contentwarehouse_v1.services.document_service.pagers.SearchDocumentsAsyncPager

google.cloud.contentwarehouse_v1.services.document_service.pagers.SearchDocumentsPager

SearchDocumentsPager(
    method: typing.Callable[
        [...],
        google.cloud.contentwarehouse_v1.types.document_service.SearchDocumentsResponse,
    ],
    request: google.cloud.contentwarehouse_v1.types.document_service_request.SearchDocumentsRequest,
    response: google.cloud.contentwarehouse_v1.types.document_service.SearchDocumentsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiate the pager.

See more: google.cloud.contentwarehouse_v1.services.document_service.pagers.SearchDocumentsPager

google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceAsyncClient

PipelineServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.contentwarehouse_v1.services.pipeline_service.transports.base.PipelineServiceTransport, typing.Callable[[...], google.cloud.contentwarehouse_v1.services.pipeline_service.transports.base.PipelineServiceTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the pipeline service async client.

See more: google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceAsyncClient

google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceAsyncClient.cloud_function_path

cloud_function_path(project: str, location: str, function: str) -> str

Returns a fully-qualified cloud_function string.

See more: google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceAsyncClient.cloud_function_path

google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceAsyncClient.common_billing_account_path

google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceAsyncClient.common_folder_path

google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceAsyncClient.common_location_path

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

Returns a fully-qualified location string.

See more: google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceAsyncClient.common_location_path

google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceAsyncClient.common_organization_path

google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceAsyncClient.common_project_path

google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceAsyncClient.from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceAsyncClient.from_service_account_file

google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceAsyncClient.from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

See more: google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceAsyncClient.from_service_account_info

google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceAsyncClient.from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceAsyncClient.from_service_account_json

google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceAsyncClient.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.

See more: google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceAsyncClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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.

See more: google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceAsyncClient.get_operation

google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceAsyncClient.get_transport_class

get_transport_class() -> (
    typing.Type[
        google.cloud.contentwarehouse_v1.services.pipeline_service.transports.base.PipelineServiceTransport
    ]
)

Returns an appropriate transport class.

See more: google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceAsyncClient.get_transport_class

google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceAsyncClient.location_path

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

Returns a fully-qualified location string.

See more: google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceAsyncClient.location_path

google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceAsyncClient.parse_cloud_function_path

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

Parses a cloud_function path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceAsyncClient.parse_cloud_function_path

google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceAsyncClient.parse_common_billing_account_path

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

Parse a billing_account path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceAsyncClient.parse_common_billing_account_path

google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceAsyncClient.parse_common_folder_path

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

Parse a folder path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceAsyncClient.parse_common_folder_path

google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceAsyncClient.parse_common_location_path

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

Parse a location path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceAsyncClient.parse_common_location_path

google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceAsyncClient.parse_common_organization_path

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

Parse a organization path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceAsyncClient.parse_common_organization_path

google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceAsyncClient.parse_common_project_path

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

Parse a project path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceAsyncClient.parse_common_project_path

google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceAsyncClient.parse_location_path

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

Parses a location path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceAsyncClient.parse_location_path

google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceAsyncClient.run_pipeline

run_pipeline(
    request: typing.Optional[
        typing.Union[
            google.cloud.contentwarehouse_v1.types.pipeline_service.RunPipelineRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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

Run a predefined pipeline.

See more: google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceAsyncClient.run_pipeline

google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceClient

PipelineServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.contentwarehouse_v1.services.pipeline_service.transports.base.PipelineServiceTransport, typing.Callable[[...], google.cloud.contentwarehouse_v1.services.pipeline_service.transports.base.PipelineServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the pipeline service client.

See more: google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceClient

google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceClient.exit

google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceClient.cloud_function_path

cloud_function_path(project: str, location: str, function: str) -> str

Returns a fully-qualified cloud_function string.

See more: google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceClient.cloud_function_path

google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceClient.common_billing_account_path

google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceClient.common_folder_path

google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceClient.common_location_path

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

Returns a fully-qualified location string.

See more: google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceClient.common_location_path

google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceClient.common_organization_path

google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceClient.common_project_path

google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceClient.from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceClient.from_service_account_file

google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceClient.from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

See more: google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceClient.from_service_account_info

google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceClient.from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceClient.from_service_account_json

google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated.

See more: google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceClient.get_mtls_endpoint_and_cert_source

google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.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.

See more: google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceClient.get_operation

google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceClient.location_path

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

Returns a fully-qualified location string.

See more: google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceClient.location_path

google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceClient.parse_cloud_function_path

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

Parses a cloud_function path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceClient.parse_cloud_function_path

google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceClient.parse_common_billing_account_path

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

Parse a billing_account path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceClient.parse_common_billing_account_path

google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceClient.parse_common_folder_path

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

Parse a folder path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceClient.parse_common_folder_path

google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceClient.parse_common_location_path

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

Parse a location path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceClient.parse_common_location_path

google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceClient.parse_common_organization_path

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

Parse a organization path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceClient.parse_common_organization_path

google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceClient.parse_common_project_path

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

Parse a project path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceClient.parse_common_project_path

google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceClient.parse_location_path

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

Parses a location path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceClient.parse_location_path

google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceClient.run_pipeline

run_pipeline(
    request: typing.Optional[
        typing.Union[
            google.cloud.contentwarehouse_v1.types.pipeline_service.RunPipelineRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.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.Operation

Run a predefined pipeline.

See more: google.cloud.contentwarehouse_v1.services.pipeline_service.PipelineServiceClient.run_pipeline

google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceAsyncClient

RuleSetServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.contentwarehouse_v1.services.rule_set_service.transports.base.RuleSetServiceTransport, typing.Callable[[...], google.cloud.contentwarehouse_v1.services.rule_set_service.transports.base.RuleSetServiceTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the rule set service async client.

See more: google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceAsyncClient

google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceAsyncClient.common_billing_account_path

google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceAsyncClient.common_folder_path

google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceAsyncClient.common_location_path

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

Returns a fully-qualified location string.

See more: google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceAsyncClient.common_location_path

google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceAsyncClient.common_organization_path

google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceAsyncClient.common_project_path

google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceAsyncClient.create_rule_set

create_rule_set(
    request: typing.Optional[
        typing.Union[
            google.cloud.contentwarehouse_v1.types.ruleset_service_request.CreateRuleSetRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    rule_set: typing.Optional[
        google.cloud.contentwarehouse_v1.types.rule_engine.RuleSet
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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.rule_engine.RuleSet

Creates a ruleset.

See more: google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceAsyncClient.create_rule_set

google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceAsyncClient.delete_rule_set

delete_rule_set(
    request: typing.Optional[
        typing.Union[
            google.cloud.contentwarehouse_v1.types.ruleset_service_request.DeleteRuleSetRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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 ruleset.

See more: google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceAsyncClient.delete_rule_set

google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceAsyncClient.document_path

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

Returns a fully-qualified document string.

See more: google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceAsyncClient.document_path

google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceAsyncClient.from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceAsyncClient.from_service_account_file

google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceAsyncClient.from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

See more: google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceAsyncClient.from_service_account_info

google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceAsyncClient.from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceAsyncClient.from_service_account_json

google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceAsyncClient.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.

See more: google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceAsyncClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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.

See more: google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceAsyncClient.get_operation

google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceAsyncClient.get_rule_set

get_rule_set(
    request: typing.Optional[
        typing.Union[
            google.cloud.contentwarehouse_v1.types.ruleset_service_request.GetRuleSetRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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.rule_engine.RuleSet

Gets a ruleset.

See more: google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceAsyncClient.get_rule_set

google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceAsyncClient.get_transport_class

get_transport_class() -> (
    typing.Type[
        google.cloud.contentwarehouse_v1.services.rule_set_service.transports.base.RuleSetServiceTransport
    ]
)

Returns an appropriate transport class.

See more: google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceAsyncClient.get_transport_class

google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceAsyncClient.list_rule_sets

list_rule_sets(
    request: typing.Optional[
        typing.Union[
            google.cloud.contentwarehouse_v1.types.ruleset_service_request.ListRuleSetsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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.rule_set_service.pagers.ListRuleSetsAsyncPager
)

Lists rulesets.

See more: google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceAsyncClient.list_rule_sets

google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceAsyncClient.location_path

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

Returns a fully-qualified location string.

See more: google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceAsyncClient.location_path

google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceAsyncClient.parse_common_billing_account_path

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

Parse a billing_account path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceAsyncClient.parse_common_billing_account_path

google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceAsyncClient.parse_common_folder_path

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

Parse a folder path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceAsyncClient.parse_common_folder_path

google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceAsyncClient.parse_common_location_path

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

Parse a location path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceAsyncClient.parse_common_location_path

google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceAsyncClient.parse_common_organization_path

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

Parse a organization path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceAsyncClient.parse_common_organization_path

google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceAsyncClient.parse_common_project_path

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

Parse a project path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceAsyncClient.parse_common_project_path

google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceAsyncClient.parse_document_path

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

Parses a document path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceAsyncClient.parse_document_path

google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceAsyncClient.parse_location_path

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

Parses a location path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceAsyncClient.parse_location_path

google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceAsyncClient.parse_rule_set_path

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

Parses a rule_set path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceAsyncClient.parse_rule_set_path

google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceAsyncClient.rule_set_path

rule_set_path(project: str, location: str, rule_set: str) -> str

Returns a fully-qualified rule_set string.

See more: google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceAsyncClient.rule_set_path

google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceAsyncClient.update_rule_set

update_rule_set(
    request: typing.Optional[
        typing.Union[
            google.cloud.contentwarehouse_v1.types.ruleset_service_request.UpdateRuleSetRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    rule_set: typing.Optional[
        google.cloud.contentwarehouse_v1.types.rule_engine.RuleSet
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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.rule_engine.RuleSet

Updates a ruleset.

See more: google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceAsyncClient.update_rule_set

google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceClient

RuleSetServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.contentwarehouse_v1.services.rule_set_service.transports.base.RuleSetServiceTransport, typing.Callable[[...], google.cloud.contentwarehouse_v1.services.rule_set_service.transports.base.RuleSetServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the rule set service client.

See more: google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceClient

google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceClient.exit

google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceClient.common_billing_account_path

google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceClient.common_folder_path

google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceClient.common_location_path

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

Returns a fully-qualified location string.

See more: google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceClient.common_location_path

google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceClient.common_organization_path

google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceClient.common_project_path

google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceClient.create_rule_set

create_rule_set(
    request: typing.Optional[
        typing.Union[
            google.cloud.contentwarehouse_v1.types.ruleset_service_request.CreateRuleSetRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    rule_set: typing.Optional[
        google.cloud.contentwarehouse_v1.types.rule_engine.RuleSet
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.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.rule_engine.RuleSet

Creates a ruleset.

See more: google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceClient.create_rule_set

google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceClient.delete_rule_set

delete_rule_set(
    request: typing.Optional[
        typing.Union[
            google.cloud.contentwarehouse_v1.types.ruleset_service_request.DeleteRuleSetRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.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 ruleset.

See more: google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceClient.delete_rule_set

google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceClient.document_path

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

Returns a fully-qualified document string.

See more: google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceClient.document_path

google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceClient.from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceClient.from_service_account_file

google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceClient.from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

See more: google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceClient.from_service_account_info

google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceClient.from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceClient.from_service_account_json

google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated.

See more: google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceClient.get_mtls_endpoint_and_cert_source

google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.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.

See more: google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceClient.get_operation

google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceClient.get_rule_set

get_rule_set(
    request: typing.Optional[
        typing.Union[
            google.cloud.contentwarehouse_v1.types.ruleset_service_request.GetRuleSetRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.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.rule_engine.RuleSet

Gets a ruleset.

See more: google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceClient.get_rule_set

google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceClient.list_rule_sets

list_rule_sets(
    request: typing.Optional[
        typing.Union[
            google.cloud.contentwarehouse_v1.types.ruleset_service_request.ListRuleSetsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.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.rule_set_service.pagers.ListRuleSetsPager
)

Lists rulesets.

See more: google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceClient.list_rule_sets

google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceClient.location_path

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

Returns a fully-qualified location string.

See more: google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceClient.location_path

google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceClient.parse_common_billing_account_path

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

Parse a billing_account path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceClient.parse_common_billing_account_path

google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceClient.parse_common_folder_path

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

Parse a folder path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceClient.parse_common_folder_path

google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceClient.parse_common_location_path

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

Parse a location path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceClient.parse_common_location_path

google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceClient.parse_common_organization_path

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

Parse a organization path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceClient.parse_common_organization_path

google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceClient.parse_common_project_path

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

Parse a project path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceClient.parse_common_project_path

google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceClient.parse_document_path

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

Parses a document path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceClient.parse_document_path

google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceClient.parse_location_path

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

Parses a location path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceClient.parse_location_path

google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceClient.parse_rule_set_path

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

Parses a rule_set path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceClient.parse_rule_set_path

google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceClient.rule_set_path

rule_set_path(project: str, location: str, rule_set: str) -> str

Returns a fully-qualified rule_set string.

See more: google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceClient.rule_set_path

google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceClient.update_rule_set

update_rule_set(
    request: typing.Optional[
        typing.Union[
            google.cloud.contentwarehouse_v1.types.ruleset_service_request.UpdateRuleSetRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    rule_set: typing.Optional[
        google.cloud.contentwarehouse_v1.types.rule_engine.RuleSet
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.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.rule_engine.RuleSet

Updates a ruleset.

See more: google.cloud.contentwarehouse_v1.services.rule_set_service.RuleSetServiceClient.update_rule_set

google.cloud.contentwarehouse_v1.services.rule_set_service.pagers.ListRuleSetsAsyncPager

ListRuleSetsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.contentwarehouse_v1.types.ruleset_service_request.ListRuleSetsResponse
        ],
    ],
    request: google.cloud.contentwarehouse_v1.types.ruleset_service_request.ListRuleSetsRequest,
    response: google.cloud.contentwarehouse_v1.types.ruleset_service_request.ListRuleSetsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiates the pager.

See more: google.cloud.contentwarehouse_v1.services.rule_set_service.pagers.ListRuleSetsAsyncPager

google.cloud.contentwarehouse_v1.services.rule_set_service.pagers.ListRuleSetsPager

ListRuleSetsPager(
    method: typing.Callable[
        [...],
        google.cloud.contentwarehouse_v1.types.ruleset_service_request.ListRuleSetsResponse,
    ],
    request: google.cloud.contentwarehouse_v1.types.ruleset_service_request.ListRuleSetsRequest,
    response: google.cloud.contentwarehouse_v1.types.ruleset_service_request.ListRuleSetsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiate the pager.

See more: google.cloud.contentwarehouse_v1.services.rule_set_service.pagers.ListRuleSetsPager

google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceAsyncClient

SynonymSetServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.contentwarehouse_v1.services.synonym_set_service.transports.base.SynonymSetServiceTransport, typing.Callable[[...], google.cloud.contentwarehouse_v1.services.synonym_set_service.transports.base.SynonymSetServiceTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the synonym set service async client.

See more: google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceAsyncClient

google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceAsyncClient.common_billing_account_path

google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceAsyncClient.common_folder_path

google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceAsyncClient.common_location_path

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

Returns a fully-qualified location string.

See more: google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceAsyncClient.common_location_path

google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceAsyncClient.common_organization_path

google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceAsyncClient.common_project_path

google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceAsyncClient.create_synonym_set

create_synonym_set(
    request: typing.Optional[
        typing.Union[
            google.cloud.contentwarehouse_v1.types.synonymset_service_request.CreateSynonymSetRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    synonym_set: typing.Optional[
        google.cloud.contentwarehouse_v1.types.synonymset.SynonymSet
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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.synonymset.SynonymSet

Creates a SynonymSet for a single context.

See more: google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceAsyncClient.create_synonym_set

google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceAsyncClient.delete_synonym_set

delete_synonym_set(
    request: typing.Optional[
        typing.Union[
            google.cloud.contentwarehouse_v1.types.synonymset_service_request.DeleteSynonymSetRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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 SynonymSet for a given context.

See more: google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceAsyncClient.delete_synonym_set

google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceAsyncClient.from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceAsyncClient.from_service_account_file

google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceAsyncClient.from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

See more: google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceAsyncClient.from_service_account_info

google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceAsyncClient.from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceAsyncClient.from_service_account_json

google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceAsyncClient.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.

See more: google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceAsyncClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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.

See more: google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceAsyncClient.get_operation

google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceAsyncClient.get_synonym_set

get_synonym_set(
    request: typing.Optional[
        typing.Union[
            google.cloud.contentwarehouse_v1.types.synonymset_service_request.GetSynonymSetRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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.synonymset.SynonymSet

Gets a SynonymSet for a particular context.

See more: google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceAsyncClient.get_synonym_set

google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceAsyncClient.get_transport_class

get_transport_class() -> (
    typing.Type[
        google.cloud.contentwarehouse_v1.services.synonym_set_service.transports.base.SynonymSetServiceTransport
    ]
)

Returns an appropriate transport class.

See more: google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceAsyncClient.get_transport_class

google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceAsyncClient.list_synonym_sets

list_synonym_sets(
    request: typing.Optional[
        typing.Union[
            google.cloud.contentwarehouse_v1.types.synonymset_service_request.ListSynonymSetsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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.synonym_set_service.pagers.ListSynonymSetsAsyncPager
)

Returns all SynonymSets (for all contexts) for the specified location.

See more: google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceAsyncClient.list_synonym_sets

google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceAsyncClient.location_path

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

Returns a fully-qualified location string.

See more: google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceAsyncClient.location_path

google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceAsyncClient.parse_common_billing_account_path

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

Parse a billing_account path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceAsyncClient.parse_common_billing_account_path

google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceAsyncClient.parse_common_folder_path

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

Parse a folder path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceAsyncClient.parse_common_folder_path

google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceAsyncClient.parse_common_location_path

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

Parse a location path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceAsyncClient.parse_common_location_path

google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceAsyncClient.parse_common_organization_path

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

Parse a organization path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceAsyncClient.parse_common_organization_path

google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceAsyncClient.parse_common_project_path

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

Parse a project path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceAsyncClient.parse_common_project_path

google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceAsyncClient.parse_location_path

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

Parses a location path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceAsyncClient.parse_location_path

google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceAsyncClient.parse_synonym_set_path

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

Parses a synonym_set path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceAsyncClient.parse_synonym_set_path

google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceAsyncClient.synonym_set_path

synonym_set_path(project: str, location: str, context: str) -> str

Returns a fully-qualified synonym_set string.

See more: google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceAsyncClient.synonym_set_path

google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceAsyncClient.update_synonym_set

update_synonym_set(
    request: typing.Optional[
        typing.Union[
            google.cloud.contentwarehouse_v1.types.synonymset_service_request.UpdateSynonymSetRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    synonym_set: typing.Optional[
        google.cloud.contentwarehouse_v1.types.synonymset.SynonymSet
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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.synonymset.SynonymSet

Remove the existing SynonymSet for the context and replaces it with a new one.

See more: google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceAsyncClient.update_synonym_set

google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceClient

SynonymSetServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.contentwarehouse_v1.services.synonym_set_service.transports.base.SynonymSetServiceTransport, typing.Callable[[...], google.cloud.contentwarehouse_v1.services.synonym_set_service.transports.base.SynonymSetServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the synonym set service client.

See more: google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceClient

google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceClient.exit

google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceClient.common_billing_account_path

google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceClient.common_folder_path

google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceClient.common_location_path

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

Returns a fully-qualified location string.

See more: google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceClient.common_location_path

google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceClient.common_organization_path

google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceClient.common_project_path

google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceClient.create_synonym_set

create_synonym_set(
    request: typing.Optional[
        typing.Union[
            google.cloud.contentwarehouse_v1.types.synonymset_service_request.CreateSynonymSetRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    synonym_set: typing.Optional[
        google.cloud.contentwarehouse_v1.types.synonymset.SynonymSet
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.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.synonymset.SynonymSet

Creates a SynonymSet for a single context.

See more: google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceClient.create_synonym_set

google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceClient.delete_synonym_set

delete_synonym_set(
    request: typing.Optional[
        typing.Union[
            google.cloud.contentwarehouse_v1.types.synonymset_service_request.DeleteSynonymSetRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.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 SynonymSet for a given context.

See more: google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceClient.delete_synonym_set

google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceClient.from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceClient.from_service_account_file

google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceClient.from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

See more: google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceClient.from_service_account_info

google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceClient.from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceClient.from_service_account_json

google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated.

See more: google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceClient.get_mtls_endpoint_and_cert_source

google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.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.

See more: google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceClient.get_operation

google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceClient.get_synonym_set

get_synonym_set(
    request: typing.Optional[
        typing.Union[
            google.cloud.contentwarehouse_v1.types.synonymset_service_request.GetSynonymSetRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.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.synonymset.SynonymSet

Gets a SynonymSet for a particular context.

See more: google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceClient.get_synonym_set

google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceClient.list_synonym_sets

list_synonym_sets(
    request: typing.Optional[
        typing.Union[
            google.cloud.contentwarehouse_v1.types.synonymset_service_request.ListSynonymSetsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.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.synonym_set_service.pagers.ListSynonymSetsPager
)

Returns all SynonymSets (for all contexts) for the specified location.

See more: google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceClient.list_synonym_sets

google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceClient.location_path

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

Returns a fully-qualified location string.

See more: google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceClient.location_path

google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceClient.parse_common_billing_account_path

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

Parse a billing_account path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceClient.parse_common_billing_account_path

google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceClient.parse_common_folder_path

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

Parse a folder path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceClient.parse_common_folder_path

google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceClient.parse_common_location_path

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

Parse a location path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceClient.parse_common_location_path

google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceClient.parse_common_organization_path

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

Parse a organization path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceClient.parse_common_organization_path

google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceClient.parse_common_project_path

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

Parse a project path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceClient.parse_common_project_path

google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceClient.parse_location_path

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

Parses a location path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceClient.parse_location_path

google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceClient.parse_synonym_set_path

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

Parses a synonym_set path into its component segments.

See more: google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceClient.parse_synonym_set_path

google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceClient.synonym_set_path

synonym_set_path(project: str, location: str, context: str) -> str

Returns a fully-qualified synonym_set string.

See more: google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceClient.synonym_set_path

google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceClient.update_synonym_set

update_synonym_set(
    request: typing.Optional[
        typing.Union[
            google.cloud.contentwarehouse_v1.types.synonymset_service_request.UpdateSynonymSetRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    synonym_set: typing.Optional[
        google.cloud.contentwarehouse_v1.types.synonymset.SynonymSet
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.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.synonymset.SynonymSet

Remove the existing SynonymSet for the context and replaces it with a new one.

See more: google.cloud.contentwarehouse_v1.services.synonym_set_service.SynonymSetServiceClient.update_synonym_set

google.cloud.contentwarehouse_v1.services.synonym_set_service.pagers.ListSynonymSetsAsyncPager

ListSynonymSetsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.contentwarehouse_v1.types.synonymset_service_request.ListSynonymSetsResponse
        ],
    ],
    request: google.cloud.contentwarehouse_v1.types.synonymset_service_request.ListSynonymSetsRequest,
    response: google.cloud.contentwarehouse_v1.types.synonymset_service_request.ListSynonymSetsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiates the pager.

See more: google.cloud.contentwarehouse_v1.services.synonym_set_service.pagers.ListSynonymSetsAsyncPager

google.cloud.contentwarehouse_v1.services.synonym_set_service.pagers.ListSynonymSetsPager

ListSynonymSetsPager(
    method: typing.Callable[
        [...],
        google.cloud.contentwarehouse_v1.types.synonymset_service_request.ListSynonymSetsResponse,
    ],
    request: google.cloud.contentwarehouse_v1.types.synonymset_service_request.ListSynonymSetsRequest,
    response: google.cloud.contentwarehouse_v1.types.synonymset_service_request.ListSynonymSetsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiate the pager.

See more: google.cloud.contentwarehouse_v1.services.synonym_set_service.pagers.ListSynonymSetsPager