Error_reporting: add 'synth.py'. (googleapis#6082)

Closes googleapis#6069.

Author: tseaver

error_reporting/google/cloud/errorreporting_v1beta1/gapic/enums.py

@@ -1,3 +1,5 @@
+# -*- coding: utf-8 -*-
+#
 # Copyright 2018 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -13,8 +15,10 @@
 # limitations under the License.
 """Wrappers for protocol buffer enum types."""
 
+import enum
+
 
-class TimedCountAlignment(object):
+class TimedCountAlignment(enum.IntEnum):
     """
     Specifies how the time periods of error group counts are aligned.
 
@@ -38,7 +42,7 @@ class TimedCountAlignment(object):
     ALIGNMENT_EQUAL_AT_END = 2
 
 
-class ErrorGroupOrder(object):
+class ErrorGroupOrder(enum.IntEnum):
     """
     A sorting order of error groups.
 
@@ -58,7 +62,7 @@ class ErrorGroupOrder(object):
 
 
 class QueryTimeRange(object):
-    class Period(object):
+    class Period(enum.IntEnum):
         """
         The supported time ranges.
 

error_reporting/google/cloud/errorreporting_v1beta1/gapic/error_group_service_client.py

@@ -1,3 +1,5 @@
+# -*- coding: utf-8 -*-
+#
 # Copyright 2018 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -14,17 +16,22 @@
 """Accesses the google.devtools.clouderrorreporting.v1beta1 ErrorGroupService API."""
 
 import pkg_resources
+import warnings
 
+from google.oauth2 import service_account
 import google.api_core.gapic_v1.client_info
 import google.api_core.gapic_v1.config
 import google.api_core.gapic_v1.method
 import google.api_core.grpc_helpers
 import google.api_core.path_template
+import grpc
 
 from google.cloud.errorreporting_v1beta1.gapic import enums
 from google.cloud.errorreporting_v1beta1.gapic import error_group_service_client_config
+from google.cloud.errorreporting_v1beta1.gapic.transports import error_group_service_grpc_transport
 from google.cloud.errorreporting_v1beta1.proto import common_pb2
 from google.cloud.errorreporting_v1beta1.proto import error_group_service_pb2
+from google.cloud.errorreporting_v1beta1.proto import error_group_service_pb2_grpc
 
 _GAPIC_LIBRARY_VERSION = pkg_resources.get_distribution(
     'google-cloud-error-reporting', ).version
@@ -36,14 +43,31 @@ class ErrorGroupServiceClient(object):
     SERVICE_ADDRESS = 'clouderrorreporting.googleapis.com:443'
     """The default address of the service."""
 
-    # The scopes needed to make gRPC calls to all of the methods defined in
-    # this service
-    _DEFAULT_SCOPES = ('https://www.googleapis.com/auth/cloud-platform', )
-
-    # The name of the interface for this client. This is the key used to find
-    # method configuration in the client_config dictionary.
+    # The name of the interface for this client. This is the key used to
+    # find the method configuration in the client_config dictionary.
     _INTERFACE_NAME = 'google.devtools.clouderrorreporting.v1beta1.ErrorGroupService'
 
+    @classmethod
+    def from_service_account_file(cls, filename, *args, **kwargs):
+        """Creates an instance of this client using the provided credentials
+        file.
+
+        Args:
+            filename (str): The path to the service account private key json
+                file.
+            args: Additional arguments to pass to the constructor.
+            kwargs: Additional arguments to pass to the constructor.
+
+        Returns:
+            ErrorGroupServiceClient: The constructed client.
+        """
+        credentials = service_account.Credentials.from_service_account_file(
+            filename)
+        kwargs['credentials'] = credentials
+        return cls(*args, **kwargs)
+
+    from_service_account_json = from_service_account_file
+
     @classmethod
     def group_path(cls, project, group):
         """Return a fully-qualified group string."""
@@ -54,76 +78,91 @@ def group_path(cls, project, group):
         )
 
     def __init__(self,
+                 transport=None,
                  channel=None,
                  credentials=None,
                  client_config=error_group_service_client_config.config,
                  client_info=None):
         """Constructor.
 
         Args:
-            channel (grpc.Channel): A ``Channel`` instance through
-                which to make calls. This argument is mutually exclusive
+            transport (Union[~.ErrorGroupServiceGrpcTransport,
+                    Callable[[~.Credentials, type], ~.ErrorGroupServiceGrpcTransport]): A transport
+                instance, responsible for actually making the API calls.
+                The default transport uses the gRPC protocol.
+                This argument may also be a callable which returns a
+                transport instance. Callables will be sent the credentials
+                as the first argument and the default transport class as
+                the second argument.
+            channel (grpc.Channel): DEPRECATED. A ``Channel`` instance
+                through which to make calls. This argument is mutually exclusive
                 with ``credentials``; providing both will raise an exception.
             credentials (google.auth.credentials.Credentials): The
                 authorization credentials to attach to requests. These
                 credentials identify this application to the service. If none
                 are specified, the client will attempt to ascertain the
                 credentials from the environment.
-            client_config (dict): A dictionary of call options for each
-                method. If not specified, the default configuration is used.
+                This argument is mutually exclusive with providing a
+                transport instance to ``transport``; doing so will raise
+                an exception.
+            client_config (dict): DEPRECATED. A dictionary of call options for
+                each method. If not specified, the default configuration is used.
             client_info (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.
         """
-        # If both `channel` and `credentials` are specified, raise an
-        # exception (channels come with credentials baked in already).
-        if channel is not None and credentials is not None:
-            raise ValueError(
-                'The `channel` and `credentials` arguments to {} are mutually '
-                'exclusive.'.format(self.__class__.__name__), )
-
-        # Create the channel.
-        if channel is None:
-            channel = google.api_core.grpc_helpers.create_channel(
-                self.SERVICE_ADDRESS,
+        # Raise deprecation warnings for things we want to go away.
+        if client_config:
+            warnings.warn('The `client_config` argument is deprecated.',
+                          PendingDeprecationWarning)
+        if channel:
+            warnings.warn(
+                'The `channel` argument is deprecated; use '
+                '`transport` instead.', PendingDeprecationWarning)
+
+        # Instantiate the transport.
+        # The transport is responsible for handling serialization and
+        # deserialization and actually sending data to the service.
+        if transport:
+            if callable(transport):
+                self.transport = transport(
+                    credentials=credentials,
+                    default_class=error_group_service_grpc_transport.
+                    ErrorGroupServiceGrpcTransport,
+                )
+            else:
+                if credentials:
+                    raise ValueError(
+                        'Received both a transport instance and '
+                        'credentials; these are mutually exclusive.')
+                self.transport = transport
+        else:
+            self.transport = error_group_service_grpc_transport.ErrorGroupServiceGrpcTransport(
+                address=self.SERVICE_ADDRESS,
+                channel=channel,
                 credentials=credentials,
-                scopes=self._DEFAULT_SCOPES,
             )
 
-        # Create the gRPC stubs.
-        self.error_group_service_stub = (
-            error_group_service_pb2.ErrorGroupServiceStub(channel))
-
         if client_info is None:
             client_info = (
                 google.api_core.gapic_v1.client_info.DEFAULT_CLIENT_INFO)
         client_info.gapic_version = _GAPIC_LIBRARY_VERSION
+        self._client_info = client_info
 
         # Parse out the default settings for retry and timeout for each RPC
         # from the client configuration.
         # (Ordinarily, these are the defaults specified in the `*_config.py`
         # file next to this one.)
-        method_configs = google.api_core.gapic_v1.config.parse_method_configs(
+        self._method_configs = google.api_core.gapic_v1.config.parse_method_configs(
             client_config['interfaces'][self._INTERFACE_NAME], )
 
-        # Write the "inner API call" methods to the class.
-        # These are wrapped versions of the gRPC stub methods, with retry and
-        # timeout configuration applied, called by the public methods on
-        # this class.
-        self._get_group = google.api_core.gapic_v1.method.wrap_method(
-            self.error_group_service_stub.GetGroup,
-            default_retry=method_configs['GetGroup'].retry,
-            default_timeout=method_configs['GetGroup'].timeout,
-            client_info=client_info,
-        )
-        self._update_group = google.api_core.gapic_v1.method.wrap_method(
-            self.error_group_service_stub.UpdateGroup,
-            default_retry=method_configs['UpdateGroup'].retry,
-            default_timeout=method_configs['UpdateGroup'].timeout,
-            client_info=client_info,
-        )
+        # Save a dictionary of cached API call functions.
+        # These are the actual callables which invoke the proper
+        # transport methods, wrapped with `wrap_method` to add retry,
+        # timeout, and the like.
+        self._inner_api_calls = {}
 
     # Service calls
     def get_group(self,
@@ -171,12 +210,19 @@ def get_group(self,
                     to a retryable error and retry attempts failed.
             ValueError: If the parameters are invalid.
         """
-        if metadata is None:
-            metadata = []
-        metadata = list(metadata)
+        # Wrap the transport method to add retry and timeout logic.
+        if 'get_group' not in self._inner_api_calls:
+            self._inner_api_calls[
+                'get_group'] = google.api_core.gapic_v1.method.wrap_method(
+                    self.transport.get_group,
+                    default_retry=self._method_configs['GetGroup'].retry,
+                    default_timeout=self._method_configs['GetGroup'].timeout,
+                    client_info=self._client_info,
+                )
+
         request = error_group_service_pb2.GetGroupRequest(
             group_name=group_name, )
-        return self._get_group(
+        return self._inner_api_calls['get_group'](
             request, retry=retry, timeout=timeout, metadata=metadata)
 
     def update_group(self,
@@ -193,6 +239,7 @@ def update_group(self,
             >>>
             >>> client = errorreporting_v1beta1.ErrorGroupServiceClient()
             >>>
+            >>> # TODO: Initialize ``group``:
             >>> group = {}
             >>>
             >>> response = client.update_group(group)
@@ -220,9 +267,17 @@ def update_group(self,
                     to a retryable error and retry attempts failed.
             ValueError: If the parameters are invalid.
         """
-        if metadata is None:
-            metadata = []
-        metadata = list(metadata)
+        # Wrap the transport method to add retry and timeout logic.
+        if 'update_group' not in self._inner_api_calls:
+            self._inner_api_calls[
+                'update_group'] = google.api_core.gapic_v1.method.wrap_method(
+                    self.transport.update_group,
+                    default_retry=self._method_configs['UpdateGroup'].retry,
+                    default_timeout=self._method_configs['UpdateGroup'].
+                    timeout,
+                    client_info=self._client_info,
+                )
+
         request = error_group_service_pb2.UpdateGroupRequest(group=group, )
-        return self._update_group(
+        return self._inner_api_calls['update_group'](
             request, retry=retry, timeout=timeout, metadata=metadata)