feat: add disposition_time, legal_hold, document_is_retention_folder, document_is_legal_hold_folder, question_answer, document_name_filter field to Document Warehouse API v1 (#11565)

gcf-owl-bot[bot] · parthea · web-flow · commit d0432c7b7754 · 2023-08-11T12:50:03.000Z
Co-authored-by: Owl Bot &lt;gcf-owl-bot[bot]@users.noreply.github.com&gt;
Co-authored-by: Anthonios Partheniou &lt;partheniou@google.com&gt;
diff --git a/packages/google-cloud-contentwarehouse/.flake8 b/packages/google-cloud-contentwarehouse/.flake8
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright 2020 Google LLC
+# Copyright 2023 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
diff --git a/packages/google-cloud-contentwarehouse/CONTRIBUTING.rst b/packages/google-cloud-contentwarehouse/CONTRIBUTING.rst
@@ -236,7 +236,7 @@ We support:
 
 Supported versions can be found in our ``noxfile.py`` `config`_.
 
-.. _config: https://github.com/googleapis/google-cloud-python/blob/main/noxfile.py
+.. _config: https://github.com/googleapis/google-cloud-python/blob/main/packages/google-cloud-contentwarehouse/noxfile.py
 
 
 **********
diff --git a/packages/google-cloud-contentwarehouse/MANIFEST.in b/packages/google-cloud-contentwarehouse/MANIFEST.in
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright 2020 Google LLC
+# Copyright 2023 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
diff --git a/packages/google-cloud-contentwarehouse/README.rst b/packages/google-cloud-contentwarehouse/README.rst
@@ -36,21 +36,24 @@ In order to use this library, you first need to go through the following steps:
 Installation
 ~~~~~~~~~~~~
 
-Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to
-create isolated Python environments. The basic problem it addresses is one of
-dependencies and versions, and indirectly permissions.
+Install this library in a virtual environment using `venv`_. `venv`_ is a tool that
+creates isolated Python environments. These isolated environments can have separate
+versions of Python packages, which allows you to isolate one project's dependencies
+from the dependencies of other projects.
 
-With `virtualenv`_, it's possible to install this library without needing system
+With `venv`_, it's possible to install this library without needing system
 install permissions, and without clashing with the installed system
 dependencies.
 
-.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/
+.. _`venv`: https://docs.python.org/3/library/venv.html
 
 
 Code samples and snippets
 ~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Code samples and snippets live in the `samples/` folder.
+Code samples and snippets live in the `samples/`_ folder.
+
+.. _samples/: https://github.com/googleapis/google-cloud-python/tree/main/packages/google-cloud-contentwarehouse/samples
 
 
 Supported Python Versions
@@ -77,21 +80,19 @@ Mac/Linux
 
 .. code-block:: console
 
-    pip install virtualenv
-    virtualenv <your-env>
+    python3 -m venv <your-env>
     source <your-env>/bin/activate
-    <your-env>/bin/pip install google-cloud-contentwarehouse
+    pip install google-cloud-contentwarehouse
 
 
 Windows
 ^^^^^^^
 
 .. code-block:: console
 
-    pip install virtualenv
-    virtualenv <your-env>
-    <your-env>\Scripts\activate
-    <your-env>\Scripts\pip.exe install google-cloud-contentwarehouse
+    py -m venv <your-env>
+    .\<your-env>\Scripts\activate
+    pip install google-cloud-contentwarehouse
 
 Next Steps
 ~~~~~~~~~~
diff --git a/packages/google-cloud-contentwarehouse/docs/conf.py b/packages/google-cloud-contentwarehouse/docs/conf.py
@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# Copyright 2021 Google LLC
+# Copyright 2023 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
diff --git a/packages/google-cloud-contentwarehouse/google/cloud/contentwarehouse_v1/types/document.py b/packages/google-cloud-contentwarehouse/google/cloud/contentwarehouse_v1/types/document.py
@@ -180,6 +180,13 @@ class Document(proto.Message):
             The user who creates the document.
         updater (str):
             The user who lastly updates the document.
+        disposition_time (google.protobuf.timestamp_pb2.Timestamp):
+            Output only. If linked to a Collection with
+            RetentionPolicy, the date when the document
+            becomes mutable.
+        legal_hold (bool):
+            Output only. Indicates if the document has a
+            legal hold on it.
     """
 
     name: str = proto.Field(
@@ -276,6 +283,15 @@ class Document(proto.Message):
         proto.STRING,
         number=14,
     )
+    disposition_time: timestamp_pb2.Timestamp = proto.Field(
+        proto.MESSAGE,
+        number=22,
+        message=timestamp_pb2.Timestamp,
+    )
+    legal_hold: bool = proto.Field(
+        proto.BOOL,
+        number=23,
+    )
 
 
 class DocumentReference(proto.Message):
@@ -304,6 +320,10 @@ class DocumentReference(proto.Message):
         delete_time (google.protobuf.timestamp_pb2.Timestamp):
             Output only. The time when the document is
             deleted.
+        document_is_retention_folder (bool):
+            Document is a folder with retention policy.
+        document_is_legal_hold_folder (bool):
+            Document is a folder with legal hold.
     """
 
     document_name: str = proto.Field(
@@ -337,6 +357,14 @@ class DocumentReference(proto.Message):
         number=7,
         message=timestamp_pb2.Timestamp,
     )
+    document_is_retention_folder: bool = proto.Field(
+        proto.BOOL,
+        number=8,
+    )
+    document_is_legal_hold_folder: bool = proto.Field(
+        proto.BOOL,
+        number=9,
+    )
 
 
 class Property(proto.Message):
diff --git a/packages/google-cloud-contentwarehouse/google/cloud/contentwarehouse_v1/types/document_service.py b/packages/google-cloud-contentwarehouse/google/cloud/contentwarehouse_v1/types/document_service.py
@@ -189,6 +189,10 @@ class SearchDocumentsResponse(proto.Message):
         histogram_query_results (MutableSequence[google.cloud.contentwarehouse_v1.types.HistogramQueryResult]):
             The histogram results that match with the specified
             [SearchDocumentsRequest.histogram_queries][google.cloud.contentwarehouse.v1.SearchDocumentsRequest.histogram_queries].
+        question_answer (str):
+            Experimental.
+            Question answer from the query against the
+            document.
     """
 
     class MatchingDocument(proto.Message):
@@ -262,6 +266,10 @@ def raw_page(self):
         number=6,
         message=histogram.HistogramQueryResult,
     )
+    question_answer: str = proto.Field(
+        proto.STRING,
+        number=7,
+    )
 
 
 class FetchAclResponse(proto.Message):
diff --git a/packages/google-cloud-contentwarehouse/google/cloud/contentwarehouse_v1/types/filters.py b/packages/google-cloud-contentwarehouse/google/cloud/contentwarehouse_v1/types/filters.py
@@ -150,6 +150,9 @@ class DocumentQuery(proto.Message):
             Search all the documents under this specified folder.
             Format:
             projects/{project_number}/locations/{location}/documents/{document_id}.
+        document_name_filter (MutableSequence[str]):
+            Search the documents in the list. Format:
+            projects/{project_number}/locations/{location}/documents/{document_id}.
         query_context (MutableSequence[str]):
             For custom synonyms.
             Customers provide the synonyms based on context.
@@ -214,6 +217,10 @@ class DocumentQuery(proto.Message):
         proto.STRING,
         number=9,
     )
+    document_name_filter: MutableSequence[str] = proto.RepeatedField(
+        proto.STRING,
+        number=14,
+    )
     query_context: MutableSequence[str] = proto.RepeatedField(
         proto.STRING,
         number=10,
@@ -251,10 +258,13 @@ class TimeField(proto.Enum):
                 Earliest document create time.
             UPDATE_TIME (2):
                 Latest document update time.
+            DISPOSITION_TIME (3):
+                Time when document becomes mutable again.
         """
         TIME_FIELD_UNSPECIFIED = 0
         CREATE_TIME = 1
         UPDATE_TIME = 2
+        DISPOSITION_TIME = 3
 
     time_range: interval_pb2.Interval = proto.Field(
         proto.MESSAGE,
diff --git a/packages/google-cloud-contentwarehouse/google/cloud/contentwarehouse_v1/types/rule_engine.py b/packages/google-cloud-contentwarehouse/google/cloud/contentwarehouse_v1/types/rule_engine.py
@@ -113,10 +113,16 @@ class TriggerType(proto.Enum):
                 Trigger for create document action.
             ON_UPDATE (4):
                 Trigger for update document action.
+            ON_CREATE_LINK (7):
+                Trigger for create link action.
+            ON_DELETE_LINK (8):
+                Trigger for delete link action.
         """
         UNKNOWN = 0
         ON_CREATE = 1
         ON_UPDATE = 4
+        ON_CREATE_LINK = 7
+        ON_DELETE_LINK = 8
 
     description: str = proto.Field(
         proto.STRING,
diff --git a/packages/google-cloud-contentwarehouse/noxfile.py b/packages/google-cloud-contentwarehouse/noxfile.py
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright 2018 Google LLC
+# Copyright 2023 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
diff --git a/packages/google-cloud-contentwarehouse/scripts/decrypt-secrets.sh b/packages/google-cloud-contentwarehouse/scripts/decrypt-secrets.sh
@@ -1,6 +1,6 @@
 #!/bin/bash
 
-# Copyright 2015 Google Inc. All rights reserved.
+# Copyright 2023 Google LLC All rights reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
diff --git a/packages/google-cloud-contentwarehouse/tests/unit/gapic/contentwarehouse_v1/test_document_service.py b/packages/google-cloud-contentwarehouse/tests/unit/gapic/contentwarehouse_v1/test_document_service.py
@@ -1024,6 +1024,7 @@ def test_get_document(request_type, transport: str = "grpc"):
             text_extraction_enabled=True,
             creator="creator_value",
             updater="updater_value",
+            legal_hold=True,
             plain_text="plain_text_value",
             raw_document_path="raw_document_path_value",
         )
@@ -1055,6 +1056,7 @@ def test_get_document(request_type, transport: str = "grpc"):
     assert response.text_extraction_enabled is True
     assert response.creator == "creator_value"
     assert response.updater == "updater_value"
+    assert response.legal_hold is True
 
 
 def test_get_document_empty_call():
@@ -1106,6 +1108,7 @@ async def test_get_document_async(
                 text_extraction_enabled=True,
                 creator="creator_value",
                 updater="updater_value",
+                legal_hold=True,
             )
         )
         response = await client.get_document(request)
@@ -1136,6 +1139,7 @@ async def test_get_document_async(
     assert response.text_extraction_enabled is True
     assert response.creator == "creator_value"
     assert response.updater == "updater_value"
+    assert response.legal_hold is True
 
 
 @pytest.mark.asyncio
@@ -1767,6 +1771,7 @@ def test_search_documents(request_type, transport: str = "grpc"):
         call.return_value = document_service.SearchDocumentsResponse(
             next_page_token="next_page_token_value",
             total_size=1086,
+            question_answer="question_answer_value",
         )
         response = client.search_documents(request)
 
@@ -1779,6 +1784,7 @@ def test_search_documents(request_type, transport: str = "grpc"):
     assert isinstance(response, pagers.SearchDocumentsPager)
     assert response.next_page_token == "next_page_token_value"
     assert response.total_size == 1086
+    assert response.question_answer == "question_answer_value"
 
 
 def test_search_documents_empty_call():
@@ -1818,6 +1824,7 @@ async def test_search_documents_async(
             document_service.SearchDocumentsResponse(
                 next_page_token="next_page_token_value",
                 total_size=1086,
+                question_answer="question_answer_value",
             )
         )
         response = await client.search_documents(request)
@@ -1831,6 +1838,7 @@ async def test_search_documents_async(
     assert isinstance(response, pagers.SearchDocumentsAsyncPager)
     assert response.next_page_token == "next_page_token_value"
     assert response.total_size == 1086
+    assert response.question_answer == "question_answer_value"
 
 
 @pytest.mark.asyncio
@@ -2212,6 +2220,7 @@ def test_lock_document(request_type, transport: str = "grpc"):
             text_extraction_enabled=True,
             creator="creator_value",
             updater="updater_value",
+            legal_hold=True,
             plain_text="plain_text_value",
             raw_document_path="raw_document_path_value",
         )
@@ -2243,6 +2252,7 @@ def test_lock_document(request_type, transport: str = "grpc"):
     assert response.text_extraction_enabled is True
     assert response.creator == "creator_value"
     assert response.updater == "updater_value"
+    assert response.legal_hold is True
 
 
 def test_lock_document_empty_call():
@@ -2294,6 +2304,7 @@ async def test_lock_document_async(
                 text_extraction_enabled=True,
                 creator="creator_value",
                 updater="updater_value",
+                legal_hold=True,
             )
         )
         response = await client.lock_document(request)
@@ -2324,6 +2335,7 @@ async def test_lock_document_async(
     assert response.text_extraction_enabled is True
     assert response.creator == "creator_value"
     assert response.updater == "updater_value"
+    assert response.legal_hold is True
 
 
 @pytest.mark.asyncio
@@ -3247,6 +3259,7 @@ def test_get_document_rest(request_type):
             text_extraction_enabled=True,
             creator="creator_value",
             updater="updater_value",
+            legal_hold=True,
             plain_text="plain_text_value",
             raw_document_path="raw_document_path_value",
         )
@@ -3282,6 +3295,7 @@ def test_get_document_rest(request_type):
     assert response.text_extraction_enabled is True
     assert response.creator == "creator_value"
     assert response.updater == "updater_value"
+    assert response.legal_hold is True
 
 
 def test_get_document_rest_required_fields(
@@ -4072,6 +4086,7 @@ def test_search_documents_rest(request_type):
         return_value = document_service.SearchDocumentsResponse(
             next_page_token="next_page_token_value",
             total_size=1086,
+            question_answer="question_answer_value",
         )
 
         # Wrap the value into a proper Response obj
@@ -4088,6 +4103,7 @@ def test_search_documents_rest(request_type):
     assert isinstance(response, pagers.SearchDocumentsPager)
     assert response.next_page_token == "next_page_token_value"
     assert response.total_size == 1086
+    assert response.question_answer == "question_answer_value"
 
 
 def test_search_documents_rest_required_fields(
@@ -4416,6 +4432,7 @@ def test_lock_document_rest(request_type):
             text_extraction_enabled=True,
             creator="creator_value",
             updater="updater_value",
+            legal_hold=True,
             plain_text="plain_text_value",
             raw_document_path="raw_document_path_value",
         )
@@ -4451,6 +4468,7 @@ def test_lock_document_rest(request_type):
     assert response.text_extraction_enabled is True
     assert response.creator == "creator_value"
     assert response.updater == "updater_value"
+    assert response.legal_hold is True
 
 
 def test_lock_document_rest_required_fields(

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`# -- coding: utf-8 --`
`2`	`2`	`#`
`3`		`-# Copyright 2020 Google LLC`
	`3`	`+# Copyright 2023 Google LLC`
`4`	`4`	`#`
`5`	`5`	`# Licensed under the Apache License, Version 2.0 (the "License");`
`6`	`6`	`# you may not use this file except in compliance with the License.`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`# -- coding: utf-8 --`
`2`		`-# Copyright 2021 Google LLC`
	`2`	`+# Copyright 2023 Google LLC`
`3`	`3`	`#`
`4`	`4`	`# Licensed under the Apache License, Version 2.0 (the "License");`
`5`	`5`	`# you may not use this file except in compliance with the License.`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`# -- coding: utf-8 --`
`2`	`2`	`#`
`3`		`-# Copyright 2018 Google LLC`
	`3`	`+# Copyright 2023 Google LLC`
`4`	`4`	`#`
`5`	`5`	`# Licensed under the Apache License, Version 2.0 (the "License");`
`6`	`6`	`# you may not use this file except in compliance with the License.`