Class DocumentServiceClient (0.2.1)
Stay organized with collections
Save and categorize content based on your preferences.
DocumentServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.contentwarehouse_v1.services.document_service.transports.base.DocumentServiceTransport]] = None, client_options: Optional[Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)This service lets you manage document.
Properties
transport
Returns the transport used by the client instance.
Methods
DocumentServiceClient
DocumentServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.contentwarehouse_v1.services.document_service.transports.base.DocumentServiceTransport]] = None, client_options: Optional[Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)Instantiates the document service client.
Optional[google.auth.credentials.Credentials]
The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
Union[str, DocumentServiceTransport]
The transport to use. If set to None, a transport is chosen automatically.
Optional[Union[google.api_core.client_options.ClientOptions, dict]]
Custom options for the client. It won't take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used.
google.api_core.gapic_v1.client_info.ClientInfo
The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you're developing your own client library.
__exit__
__exit__(type, value, traceback)Releases underlying transport's resources.
common_billing_account_path
common_billing_account_path(billing_account: str)Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str)Returns a fully-qualified project string.
create_document
create_document(request: Optional[Union[google.cloud.contentwarehouse_v1.types.document_service_request.CreateDocumentRequest, dict]] = None, *, parent: Optional[str] = None, document: Optional[google.cloud.contentwarehouse_v1.types.document.Document] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())Creates a document.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import contentwarehouse_v1
def sample_create_document():
# Create a client
client = contentwarehouse_v1.DocumentServiceClient()
# Initialize request argument(s)
document = contentwarehouse_v1.Document()
document.plain_text = "plain_text_value"
document.raw_document_path = "raw_document_path_value"
document.display_name = "display_name_value"
request = contentwarehouse_v1.CreateDocumentRequest(
parent="parent_value",
document=document,
)
# Make the request
response = client.create_document(request=request)
# Handle the response
print(response)
Union[google.cloud.contentwarehouse_v1.types.CreateDocumentRequest, dict]
The request object. Request message for DocumentService.CreateDocument.
str
Required. The parent name. Format: projects/{project_number}/locations/{location}. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
google.cloud.contentwarehouse_v1.types.Document
Required. The document to create. This corresponds to the document field on the request instance; if request is provided, this should not be set.
google.api_core.retry.Retry
Designation of what errors, if any, should be retried.
float
The timeout for this request.
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata.
delete_document
delete_document(request: Optional[Union[google.cloud.contentwarehouse_v1.types.document_service_request.DeleteDocumentRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())Deletes a document. Returns NOT_FOUND if the document does not exist.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import contentwarehouse_v1
def sample_delete_document():
# Create a client
client = contentwarehouse_v1.DocumentServiceClient()
# Initialize request argument(s)
request = contentwarehouse_v1.DeleteDocumentRequest(
name="name_value",
)
# Make the request
client.delete_document(request=request)
Union[google.cloud.contentwarehouse_v1.types.DeleteDocumentRequest, dict]
The request object. Request message for DocumentService.DeleteDocument.
str
Required. The name of the document to delete. Format: projects/{project_number}/locations/{location}/documents/{document_id} or projects/{project_number}/locations/{location}/documents/referenceId/{reference_id}. This corresponds to the name field on the request instance; if request is provided, this should not be set.
google.api_core.retry.Retry
Designation of what errors, if any, should be retried.
float
The timeout for this request.
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata.
document_path
document_path(project: str, location: str, document: str)Returns a fully-qualified document string.
document_schema_path
document_schema_path(project: str, location: str, document_schema: str)Returns a fully-qualified document_schema string.
fetch_acl
fetch_acl(request: Optional[Union[google.cloud.contentwarehouse_v1.types.document_service_request.FetchAclRequest, dict]] = None, *, resource: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())Gets the access control policy for a resource. Returns NOT_FOUND error if the resource does not exist. Returns an empty policy if the resource exists but does not have a policy set.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import contentwarehouse_v1
def sample_fetch_acl():
# Create a client
client = contentwarehouse_v1.DocumentServiceClient()
# Initialize request argument(s)
request = contentwarehouse_v1.FetchAclRequest(
resource="resource_value",
)
# Make the request
response = client.fetch_acl(request=request)
# Handle the response
print(response)
Union[google.cloud.contentwarehouse_v1.types.FetchAclRequest, dict]
The request object. Request message for DocumentService.FetchAcl
str
Required. REQUIRED: The resource for which the policy is being requested. Format for document: projects/{project_number}/locations/{location}/documents/{document_id}. Format for project: projects/{project_number}. This corresponds to the resource field on the request instance; if request is provided, this should not be set.
google.api_core.retry.Retry
Designation of what errors, if any, should be retried.
float
The timeout for this request.
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata.
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)Creates an instance of this client using the provided credentials file.
str
The path to the service account private key json file.
from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)Creates an instance of this client using the provided credentials info.
dict
The service account private key info.
from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)Creates an instance of this client using the provided credentials file.
str
The path to the service account private key json file.
get_document
get_document(request: Optional[Union[google.cloud.contentwarehouse_v1.types.document_service_request.GetDocumentRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())Gets a document. Returns NOT_FOUND if the document does not exist.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import contentwarehouse_v1
def sample_get_document():
# Create a client
client = contentwarehouse_v1.DocumentServiceClient()
# Initialize request argument(s)
request = contentwarehouse_v1.GetDocumentRequest(
name="name_value",
)
# Make the request
response = client.get_document(request=request)
# Handle the response
print(response)
Union[google.cloud.contentwarehouse_v1.types.GetDocumentRequest, dict]
The request object. Request message for DocumentService.GetDocument.
str
Required. The name of the document to retrieve. Format: projects/{project_number}/locations/{location}/documents/{document_id} or projects/{project_number}/locations/{location}/documents/referenceId/{reference_id}. This corresponds to the name field on the request instance; if request is provided, this should not be set.
google.api_core.retry.Retry
Designation of what errors, if any, should be retried.
float
The timeout for this request.
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata.
get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)Return the API endpoint and client cert source for mutual TLS.
The client cert source is determined in the following order:
(1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the
client cert source is None.
(2) if client_options.client_cert_source is provided, use the provided one; if the
default client cert source exists, use the default one; otherwise the client cert
source is None.
The API endpoint is determined in the following order:
(1) if client_options.api_endpoint if provided, use the provided one.
(2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the
default mTLS endpoint; if the environment variabel is "never", use the default API
endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise
use the default API endpoint.
More details can be found at https://google.aip.dev/auth/4114.
google.api_core.client_options.ClientOptions
Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.
location_path
location_path(project: str, location: str)Returns a fully-qualified location string.
parse_common_billing_account_path
parse_common_billing_account_path(path: str)Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str)Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str)Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str)Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str)Parse a project path into its component segments.
parse_document_path
parse_document_path(path: str)Parses a document path into its component segments.
parse_document_schema_path
parse_document_schema_path(path: str)Parses a document_schema path into its component segments.
parse_location_path
parse_location_path(path: str)Parses a location path into its component segments.
search_documents
search_documents(request: Optional[Union[google.cloud.contentwarehouse_v1.types.document_service_request.SearchDocumentsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())Searches for documents using provided xref_SearchDocumentsRequest. This call only returns documents that the caller has permission to search against.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import contentwarehouse_v1
def sample_search_documents():
# Create a client
client = contentwarehouse_v1.DocumentServiceClient()
# Initialize request argument(s)
request = contentwarehouse_v1.SearchDocumentsRequest(
parent="parent_value",
)
# Make the request
page_result = client.search_documents(request=request)
# Handle the response
for response in page_result:
print(response)
Union[google.cloud.contentwarehouse_v1.types.SearchDocumentsRequest, dict]
The request object. Request message for DocumentService.SearchDocuments.
str
Required. The parent, which owns this collection of documents. Format: projects/{project_number}/locations/{location}. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
google.api_core.retry.Retry
Designation of what errors, if any, should be retried.
float
The timeout for this request.
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata.
set_acl
set_acl(request: Optional[Union[google.cloud.contentwarehouse_v1.types.document_service_request.SetAclRequest, dict]] = None, *, resource: Optional[str] = None, policy: Optional[google.iam.v1.policy_pb2.Policy] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())Sets the access control policy for a resource. Replaces any existing policy.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import contentwarehouse_v1
def sample_set_acl():
# Create a client
client = contentwarehouse_v1.DocumentServiceClient()
# Initialize request argument(s)
request = contentwarehouse_v1.SetAclRequest(
resource="resource_value",
)
# Make the request
response = client.set_acl(request=request)
# Handle the response
print(response)
Union[google.cloud.contentwarehouse_v1.types.SetAclRequest, dict]
The request object. Request message for DocumentService.SetAcl.
str
Required. REQUIRED: The resource for which the policy is being requested. Format for document: projects/{project_number}/locations/{location}/documents/{document_id}. Format for project: projects/{project_number}. This corresponds to the resource field on the request instance; if request is provided, this should not be set.
google.iam.v1.policy_pb2.Policy
Required. REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. This corresponds to the policy field on the request instance; if request is provided, this should not be set.
google.api_core.retry.Retry
Designation of what errors, if any, should be retried.
float
The timeout for this request.
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata.
update_document
update_document(request: Optional[Union[google.cloud.contentwarehouse_v1.types.document_service_request.UpdateDocumentRequest, dict]] = None, *, name: Optional[str] = None, document: Optional[google.cloud.contentwarehouse_v1.types.document.Document] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())Updates a document. Returns INVALID_ARGUMENT if the name of the document is non-empty and does not equal the existing name.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import contentwarehouse_v1
def sample_update_document():
# Create a client
client = contentwarehouse_v1.DocumentServiceClient()
# Initialize request argument(s)
document = contentwarehouse_v1.Document()
document.plain_text = "plain_text_value"
document.raw_document_path = "raw_document_path_value"
document.display_name = "display_name_value"
request = contentwarehouse_v1.UpdateDocumentRequest(
name="name_value",
document=document,
)
# Make the request
response = client.update_document(request=request)
# Handle the response
print(response)
Union[google.cloud.contentwarehouse_v1.types.UpdateDocumentRequest, dict]
The request object. Request message for DocumentService.UpdateDocument.
str
Required. The name of the document to update. Format: projects/{project_number}/locations/{location}/documents/{document_id} or projects/{project_number}/locations/{location}/documents/referenceId/{reference_id}. This corresponds to the name field on the request instance; if request is provided, this should not be set.
google.cloud.contentwarehouse_v1.types.Document
Required. The document to update. This corresponds to the document field on the request instance; if request is provided, this should not be set.
google.api_core.retry.Retry
Designation of what errors, if any, should be retried.
float
The timeout for this request.
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata.