Class v1.DocumentServiceClient (1.4.0)

  /**
   * 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent name.
   *  Format: projects/{project_number}/locations/{location}.
   */
  // const parent = 'abc123'
  /**
   *  Required. The document to create.
   */
  // const document = {}
  /**
   *  The meta information collected about the end user, used to enforce access
   *  control for the service.
   */
  // const requestMetadata = {}
  /**
   *  Default document policy during creation.
   *  This refers to an Identity and Access (IAM) policy, which specifies access
   *  controls for the Document.
   *  Conditions defined in the policy will be ignored.
   */
  // const policy = {}
  /**
   *  Request Option for processing Cloud AI Document in Document Warehouse.
   *  This field offers limited support for mapping entities from Cloud AI
   *  Document to Warehouse Document. Please consult with product team before
   *  using this field and other available options.
   */
  // const cloudAiDocumentOption = {}
  /**
   *  Field mask for creating Document fields. If mask path is empty,
   *  it means all fields are masked.
   *  For the `FieldMask` definition,
   *  see
   *  https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask.
   */
  // const createMask = {}

  // Imports the Contentwarehouse library
  const {DocumentServiceClient} = require('@google-cloud/contentwarehouse').v1;

  // Instantiates a client
  const contentwarehouseClient = new DocumentServiceClient();

  async function callCreateDocument() {
    // Construct request
    const request = {
      parent,
      document,
    };

    // Run request
    const response = await contentwarehouseClient.createDocument(request);
    console.log(response);
  }

  callCreateDocument();

  /**
   * 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  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}.
   */
  // const name = 'abc123'
  /**
   *  The meta information collected about the end user, used to enforce access
   *  control for the service.
   */
  // const requestMetadata = {}

  // Imports the Contentwarehouse library
  const {DocumentServiceClient} = require('@google-cloud/contentwarehouse').v1;

  // Instantiates a client
  const contentwarehouseClient = new DocumentServiceClient();

  async function callDeleteDocument() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await contentwarehouseClient.deleteDocument(request);
    console.log(response);
  }

  callDeleteDocument();

  /**
   * 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. REQUIRED: The resource for which the policy is being requested.
   *  Format for document:
   *  projects/{project_number}/locations/{location}/documents/{document_id}.
   *  Format for collection:
   *  projects/{project_number}/locations/{location}/collections/{collection_id}.
   *  Format for project: projects/{project_number}.
   */
  // const resource = 'abc123'
  /**
   *  The meta information collected about the end user, used to enforce access
   *  control for the service.
   */
  // const requestMetadata = {}
  /**
   *  For Get Project ACL only. Authorization check for end user will be ignored
   *  when project_owner=true.
   */
  // const projectOwner = true

  // Imports the Contentwarehouse library
  const {DocumentServiceClient} = require('@google-cloud/contentwarehouse').v1;

  // Instantiates a client
  const contentwarehouseClient = new DocumentServiceClient();

  async function callFetchAcl() {
    // Construct request
    const request = {
      resource,
    };

    // Run request
    const response = await contentwarehouseClient.fetchAcl(request);
    console.log(response);
  }

  callFetchAcl();

  /**
   * 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  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}.
   */
  // const name = 'abc123'
  /**
   *  The meta information collected about the end user, used to enforce access
   *  control for the service.
   */
  // const requestMetadata = {}

  // Imports the Contentwarehouse library
  const {DocumentServiceClient} = require('@google-cloud/contentwarehouse').v1;

  // Instantiates a client
  const contentwarehouseClient = new DocumentServiceClient();

  async function callGetDocument() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await contentwarehouseClient.getDocument(request);
    console.log(response);
  }

  callGetDocument();

  /**
   * 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the document to lock.
   *  Format:
   *  projects/{project_number}/locations/{location}/documents/{document}.
   */
  // const name = 'abc123'
  /**
   *  The collection the document connects to.
   */
  // const collectionId = 'abc123'
  /**
   *  The user information who locks the document.
   */
  // const lockingUser = {}

  // Imports the Contentwarehouse library
  const {DocumentServiceClient} = require('@google-cloud/contentwarehouse').v1;

  // Instantiates a client
  const contentwarehouseClient = new DocumentServiceClient();

  async function callLockDocument() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await contentwarehouseClient.lockDocument(request);
    console.log(response);
  }

  callLockDocument();

  /**
   * 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent, which owns this collection of documents.
   *  Format: projects/{project_number}/locations/{location}.
   */
  // const parent = 'abc123'
  /**
   *  The meta information collected about the end user, used to enforce access
   *  control and improve the search quality of the service.
   */
  // const requestMetadata = {}
  /**
   *  Query used to search against documents (keyword, filters, etc.).
   */
  // const documentQuery = {}
  /**
   *  An integer that specifies the current offset (that is, starting result
   *  location, amongst the documents deemed by the API as relevant) in search
   *  results. This field is only considered if
   *  page_token google.cloud.contentwarehouse.v1.SearchDocumentsRequest.page_token 
   *  is unset.
   *  The maximum allowed value is 5000. Otherwise an error is thrown.
   *  For example, 0 means to  return results starting from the first matching
   *  document, and 10 means to return from the 11th document. This can be used
   *  for pagination, (for example, pageSize = 10 and offset = 10 means to return
   *  from the second page).
   */
  // const offset = 1234
  /**
   *  A limit on the number of documents returned in the search results.
   *  Increasing this value above the default value of 10 can increase search
   *  response time. The value can be between 1 and 100.
   */
  // const pageSize = 1234
  /**
   *  The token specifying the current offset within search results.
   *  See
   *  SearchDocumentsResponse.next_page_token google.cloud.contentwarehouse.v1.SearchDocumentsResponse.next_page_token 
   *  for an explanation of how to obtain the next set of query results.
   */
  // const pageToken = 'abc123'
  /**
   *  The criteria determining how search results are sorted. For non-empty
   *  query, default is `"relevance desc"`. For empty query, default is
   *  `"upload_date desc"`.
   *  Supported options are:
   *  * `"relevance desc"`: By relevance descending, as determined by the API
   *    algorithms.
   *  * `"upload_date desc"`: By upload date descending.
   *  * `"upload_date"`: By upload date ascending.
   *  * `"update_date desc"`: By last updated date descending.
   *  * `"update_date"`: By last updated date ascending.
   *  * `"retrieval_importance desc"`: By retrieval importance of properties
   *    descending. This feature is still under development, please do not use
   *    unless otherwise instructed to do so.
   */
  // const orderBy = 'abc123'
  /**
   *  An expression specifying a histogram request against matching
   *  documents. Expression syntax is an aggregation function call with
   *  histogram facets and other options.
   *  The following aggregation functions are supported:
   *  * `count(string_histogram_facet)`: Count the number of matching entities
   *  for each distinct attribute value.
   *  Data types:
   *  * Histogram facet (aka filterable properties): Facet names with format
   *  <schema id>.<facet>. Facets will have the
   *  format of: `[a-zA-Z][a-zA-Z0-9_:/-.]`. If the facet is a child
   *  facet, then the parent hierarchy needs to be specified separated by
   *  dots in the prefix after the schema id. Thus, the format for a multi-
   *  level facet is: <schema id>.<parent facet name>.
   *  <child facet name>. Example:
   *  schema123.root_parent_facet.middle_facet.child_facet
   *  * DocumentSchemaId: (with no schema id prefix) to get
   *  histograms for each document type (returns the schema id path, e.g.
   *  projects/12345/locations/us-west/documentSchemas/abc123).
   *  Example expression:
   *  * Document type counts:
   *    count('DocumentSchemaId')
   *  * For schema id, abc123, get the counts for MORTGAGE_TYPE:
   *    count('abc123.MORTGAGE_TYPE')
   */
  // const histogramQueries = [1,2,3,4]
  /**
   *  Controls if the search document request requires the return of a total size
   *  of matched documents. See
   *  SearchDocumentsResponse.total_size google.cloud.contentwarehouse.v1.SearchDocumentsResponse.total_size.
   *  Enabling this flag may adversely impact performance. Hint: If this is
   *  used with pagination, set this flag on the initial query but set this
   *  to false on subsequent page calls (keep the total count locally).
   *  Defaults to false.
   */
  // const requireTotalSize = true
  /**
   *  Controls if the search document request requires the return of a total size
   *  of matched documents. See
   *  SearchDocumentsResponse.total_size google.cloud.contentwarehouse.v1.SearchDocumentsResponse.total_size.
   */
  // const totalResultSize = {}
  /**
   *  Experimental, do not use.
   *  The limit on the number of documents returned for the question-answering
   *  feature. To enable the question-answering feature, set
   *  DocumentQuery.is_nl_query  to true.
   */
  // const qaSizeLimit = 1234

  // Imports the Contentwarehouse library
  const {DocumentServiceClient} = require('@google-cloud/contentwarehouse').v1;

  // Instantiates a client
  const contentwarehouseClient = new DocumentServiceClient();

  async function callSearchDocuments() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = await contentwarehouseClient.searchDocumentsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callSearchDocuments();

  /**
   * 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. REQUIRED: The resource for which the policy is being requested.
   *  Format for document:
   *  projects/{project_number}/locations/{location}/documents/{document_id}.
   *  Format for collection:
   *  projects/{project_number}/locations/{location}/collections/{collection_id}.
   *  Format for project: projects/{project_number}.
   */
  // const resource = 'abc123'
  /**
   *  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 refers to an
   *  Identity and Access (IAM) policy, which specifies access controls for the
   *  Document.
   *  You can set ACL with condition for projects only.
   *  Supported operators are: `=`, `!=`, `<`,><=`, `="">`, and `>=` where
   *  the left of the operator is `DocumentSchemaId` or property name and the
   *  right of the operator is a number or a quoted string. You must escape
   *  backslash (\\) and quote (\") characters.
   *  Boolean expressions (AND/OR) are supported up to 3 levels of nesting (for
   *  example, "((A AND B AND C) OR D) AND E"), a maximum of 10 comparisons are
   *  allowed in the expression. The expression must be < 6000="" bytes="" in="" length.="" *="" sample="" condition:="" *="" `"documentschemaid="\" some"="" schema="" id\"="" or="" schemaid.floatpropertyname="" *="">= 10"`
   */
  // const policy = {}
  /**
   *  The meta information collected about the end user, used to enforce access
   *  control for the service.
   */
  // const requestMetadata = {}
  /**
   *  For Set Project ACL only. Authorization check for end user will be ignored
   *  when project_owner=true.
   */
  // const projectOwner = true

  // Imports the Contentwarehouse library
  const {DocumentServiceClient} = require('@google-cloud/contentwarehouse').v1;

  // Instantiates a client
  const contentwarehouseClient = new DocumentServiceClient();

  async function callSetAcl() {
    // Construct request
    const request = {
      resource,
      policy,
    };

    // Run request
    const response = await contentwarehouseClient.setAcl(request);
    console.log(response);
  }

  callSetAcl();

  /**
   * 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  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}.
   */
  // const name = 'abc123'
  /**
   *  Required. The document to update.
   */
  // const document = {}
  /**
   *  The meta information collected about the end user, used to enforce access
   *  control for the service.
   */
  // const requestMetadata = {}
  /**
   *  Request Option for processing Cloud AI Document in Document Warehouse.
   *  This field offers limited support for mapping entities from Cloud AI
   *  Document to Warehouse Document. Please consult with product team before
   *  using this field and other available options.
   */
  // const cloudAiDocumentOption = {}
  /**
   *  Options for the update operation.
   */
  // const updateOptions = {}

  // Imports the Contentwarehouse library
  const {DocumentServiceClient} = require('@google-cloud/contentwarehouse').v1;

  // Instantiates a client
  const contentwarehouseClient = new DocumentServiceClient();

  async function callUpdateDocument() {
    // Construct request
    const request = {
      name,
      document,
    };

    // Run request
    const response = await contentwarehouseClient.updateDocument(request);
    console.log(response);
  }

  callUpdateDocument();