Add 'client_options' support, update list method docstrings (via synth). (googleapis#8504)

yoshi-automation · busunkim96 · commit 0d143784dc5a · 2019-06-28T09:17:22.000-07:00
diff --git a/datalabeling/google/cloud/datalabeling_v1beta1/gapic/data_labeling_service_client.py b/datalabeling/google/cloud/datalabeling_v1beta1/gapic/data_labeling_service_client.py
@@ -21,6 +21,7 @@
 import warnings
 
 from google.oauth2 import service_account
+import google.api_core.client_options
 import google.api_core.gapic_v1.client_info
 import google.api_core.gapic_v1.config
 import google.api_core.gapic_v1.method
@@ -176,6 +177,7 @@ def __init__(
         credentials=None,
         client_config=None,
         client_info=None,
+        client_options=None,
     ):
         """Constructor.
 
@@ -206,6 +208,9 @@ def __init__(
                 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.
+            client_options (Union[dict, google.api_core.client_options.ClientOptions]):
+                Client options used to set user options on the client. API Endpoint
+                should be set through client_options.
         """
         # Raise deprecation warnings for things we want to go away.
         if client_config is not None:
@@ -224,6 +229,15 @@ def __init__(
                 stacklevel=2,
             )
 
+        api_endpoint = self.SERVICE_ADDRESS
+        if client_options:
+            if type(client_options) == dict:
+                client_options = google.api_core.client_options.from_dict(
+                    client_options
+                )
+            if client_options.api_endpoint:
+                api_endpoint = client_options.api_endpoint
+
         # Instantiate the transport.
         # The transport is responsible for handling serialization and
         # deserialization and actually sending data to the service.
@@ -232,6 +246,7 @@ def __init__(
                 self.transport = transport(
                     credentials=credentials,
                     default_class=data_labeling_service_grpc_transport.DataLabelingServiceGrpcTransport,
+                    address=api_endpoint,
                 )
             else:
                 if credentials:
@@ -242,7 +257,7 @@ def __init__(
                 self.transport = transport
         else:
             self.transport = data_labeling_service_grpc_transport.DataLabelingServiceGrpcTransport(
-                address=self.SERVICE_ADDRESS, channel=channel, credentials=credentials
+                address=api_endpoint, channel=channel, credentials=credentials
             )
 
         if client_info is None:
@@ -468,10 +483,10 @@ def list_datasets(
                 that is provided to the method.
 
         Returns:
-            A :class:`~google.gax.PageIterator` instance. By default, this
-            is an iterable of :class:`~google.cloud.datalabeling_v1beta1.types.Dataset` instances.
-            This object can also be configured to iterate over the pages
-            of the response through the `options` parameter.
+            A :class:`~google.api_core.page_iterator.PageIterator` instance.
+            An iterable of :class:`~google.cloud.datalabeling_v1beta1.types.Dataset` instances.
+            You can also iterate over the pages of the response
+            using its `pages` property.
 
         Raises:
             google.api_core.exceptions.GoogleAPICallError: If the request
@@ -928,10 +943,10 @@ def list_data_items(
                 that is provided to the method.
 
         Returns:
-            A :class:`~google.gax.PageIterator` instance. By default, this
-            is an iterable of :class:`~google.cloud.datalabeling_v1beta1.types.DataItem` instances.
-            This object can also be configured to iterate over the pages
-            of the response through the `options` parameter.
+            A :class:`~google.api_core.page_iterator.PageIterator` instance.
+            An iterable of :class:`~google.cloud.datalabeling_v1beta1.types.DataItem` instances.
+            You can also iterate over the pages of the response
+            using its `pages` property.
 
         Raises:
             google.api_core.exceptions.GoogleAPICallError: If the request
@@ -1105,10 +1120,10 @@ def list_annotated_datasets(
                 that is provided to the method.
 
         Returns:
-            A :class:`~google.gax.PageIterator` instance. By default, this
-            is an iterable of :class:`~google.cloud.datalabeling_v1beta1.types.AnnotatedDataset` instances.
-            This object can also be configured to iterate over the pages
-            of the response through the `options` parameter.
+            A :class:`~google.api_core.page_iterator.PageIterator` instance.
+            An iterable of :class:`~google.cloud.datalabeling_v1beta1.types.AnnotatedDataset` instances.
+            You can also iterate over the pages of the response
+            using its `pages` property.
 
         Raises:
             google.api_core.exceptions.GoogleAPICallError: If the request
@@ -1704,10 +1719,10 @@ def list_examples(
                 that is provided to the method.
 
         Returns:
-            A :class:`~google.gax.PageIterator` instance. By default, this
-            is an iterable of :class:`~google.cloud.datalabeling_v1beta1.types.Example` instances.
-            This object can also be configured to iterate over the pages
-            of the response through the `options` parameter.
+            A :class:`~google.api_core.page_iterator.PageIterator` instance.
+            An iterable of :class:`~google.cloud.datalabeling_v1beta1.types.Example` instances.
+            You can also iterate over the pages of the response
+            using its `pages` property.
 
         Raises:
             google.api_core.exceptions.GoogleAPICallError: If the request
@@ -1962,10 +1977,10 @@ def list_annotation_spec_sets(
                 that is provided to the method.
 
         Returns:
-            A :class:`~google.gax.PageIterator` instance. By default, this
-            is an iterable of :class:`~google.cloud.datalabeling_v1beta1.types.AnnotationSpecSet` instances.
-            This object can also be configured to iterate over the pages
-            of the response through the `options` parameter.
+            A :class:`~google.api_core.page_iterator.PageIterator` instance.
+            An iterable of :class:`~google.cloud.datalabeling_v1beta1.types.AnnotationSpecSet` instances.
+            You can also iterate over the pages of the response
+            using its `pages` property.
 
         Raises:
             google.api_core.exceptions.GoogleAPICallError: If the request
@@ -2298,10 +2313,10 @@ def list_instructions(
                 that is provided to the method.
 
         Returns:
-            A :class:`~google.gax.PageIterator` instance. By default, this
-            is an iterable of :class:`~google.cloud.datalabeling_v1beta1.types.Instruction` instances.
-            This object can also be configured to iterate over the pages
-            of the response through the `options` parameter.
+            A :class:`~google.api_core.page_iterator.PageIterator` instance.
+            An iterable of :class:`~google.cloud.datalabeling_v1beta1.types.Instruction` instances.
+            You can also iterate over the pages of the response
+            using its `pages` property.
 
         Raises:
             google.api_core.exceptions.GoogleAPICallError: If the request
@@ -2548,10 +2563,10 @@ def search_evaluations(
                 that is provided to the method.
 
         Returns:
-            A :class:`~google.gax.PageIterator` instance. By default, this
-            is an iterable of :class:`~google.cloud.datalabeling_v1beta1.types.Evaluation` instances.
-            This object can also be configured to iterate over the pages
-            of the response through the `options` parameter.
+            A :class:`~google.api_core.page_iterator.PageIterator` instance.
+            An iterable of :class:`~google.cloud.datalabeling_v1beta1.types.Evaluation` instances.
+            You can also iterate over the pages of the response
+            using its `pages` property.
 
         Raises:
             google.api_core.exceptions.GoogleAPICallError: If the request
@@ -2655,10 +2670,10 @@ def search_example_comparisons(
                 that is provided to the method.
 
         Returns:
-            A :class:`~google.gax.PageIterator` instance. By default, this
-            is an iterable of :class:`~google.cloud.datalabeling_v1beta1.types.ExampleComparison` instances.
-            This object can also be configured to iterate over the pages
-            of the response through the `options` parameter.
+            A :class:`~google.api_core.page_iterator.PageIterator` instance.
+            An iterable of :class:`~google.cloud.datalabeling_v1beta1.types.ExampleComparison` instances.
+            You can also iterate over the pages of the response
+            using its `pages` property.
 
         Raises:
             google.api_core.exceptions.GoogleAPICallError: If the request
@@ -3204,10 +3219,10 @@ def list_evaluation_jobs(
                 that is provided to the method.
 
         Returns:
-            A :class:`~google.gax.PageIterator` instance. By default, this
-            is an iterable of :class:`~google.cloud.datalabeling_v1beta1.types.EvaluationJob` instances.
-            This object can also be configured to iterate over the pages
-            of the response through the `options` parameter.
+            A :class:`~google.api_core.page_iterator.PageIterator` instance.
+            An iterable of :class:`~google.cloud.datalabeling_v1beta1.types.EvaluationJob` instances.
+            You can also iterate over the pages of the response
+            using its `pages` property.
 
         Raises:
             google.api_core.exceptions.GoogleAPICallError: If the request
diff --git a/datalabeling/synth.metadata b/datalabeling/synth.metadata
@@ -1,19 +1,19 @@
 {
-  "updateTime": "2019-06-27T19:52:21.452702Z",
+  "updateTime": "2019-06-28T12:18:17.352035Z",
   "sources": [
     {
       "generator": {
         "name": "artman",
-        "version": "0.29.1",
-        "dockerImage": "googleapis/artman@sha256:b2a73f4dda03ef8fcaa973e3ba26d0cf34091f6c22c70add663af325931aef4d"
+        "version": "0.29.2",
+        "dockerImage": "googleapis/artman@sha256:45263333b058a4b3c26a8b7680a2710f43eae3d250f791a6cb66423991dcb2df"
       }
     },
     {
       "git": {
         "name": "googleapis",
         "remote": "https://github.com/googleapis/googleapis.git",
-        "sha": "f46206aff84f4b2cde590f1e0791112214f07080",
-        "internalRef": "255318896"
+        "sha": "84c8ad4e52f8eec8f08a60636cfa597b86969b5c",
+        "internalRef": "255474859"
       }
     },
     {

Original file line number	Diff line number	Diff line change
`@@ -1,19 +1,19 @@`
`1`	`1`	`{`
`2`		`- "updateTime": "2019-06-27T19:52:21.452702Z",`
	`2`	`+ "updateTime": "2019-06-28T12:18:17.352035Z",`
`3`	`3`	`"sources": [`
`4`	`4`	`{`
`5`	`5`	`"generator": {`
`6`	`6`	`"name": "artman",`
`7`		`- "version": "0.29.1",`
`8`		`- "dockerImage": "googleapis/artman@sha256:b2a73f4dda03ef8fcaa973e3ba26d0cf34091f6c22c70add663af325931aef4d"`
	`7`	`+ "version": "0.29.2",`
	`8`	`+ "dockerImage": "googleapis/artman@sha256:45263333b058a4b3c26a8b7680a2710f43eae3d250f791a6cb66423991dcb2df"`
`9`	`9`	`}`
`10`	`10`	`},`
`11`	`11`	`{`
`12`	`12`	`"git": {`
`13`	`13`	`"name": "googleapis",`
`14`	`14`	`"remote": "https://github.com/googleapis/googleapis.git",`
`15`		`- "sha": "f46206aff84f4b2cde590f1e0791112214f07080",`
`16`		`- "internalRef": "255318896"`
	`15`	`+ "sha": "84c8ad4e52f8eec8f08a60636cfa597b86969b5c",`
	`16`	`+ "internalRef": "255474859"`
`17`	`17`	`}`
`18`	`18`	`},`
`19`	`19`	`{`