feat: Add support for apiEndpoint and deprecate serviceAddress… (#2220)

Author: yoshi-automation

Scheduler/src/V1/Gapic/CloudSchedulerGapicClient.php

@@ -122,7 +122,7 @@ private static function getClientDefaults()
     {
         return [
             'serviceName' => self::SERVICE_NAME,
-            'serviceAddress' => self::SERVICE_ADDRESS.':'.self::DEFAULT_SERVICE_PORT,
+            'apiEndpoint' => self::SERVICE_ADDRESS.':'.self::DEFAULT_SERVICE_PORT,
             'clientConfig' => __DIR__.'/../resources/cloud_scheduler_client_config.json',
             'descriptorsConfigPath' => __DIR__.'/../resources/cloud_scheduler_descriptor_config.php',
             'gcpApiConfigPath' => __DIR__.'/../resources/cloud_scheduler_grpc_config.json',
@@ -277,6 +277,9 @@ public static function parseName($formattedName, $template = null)
      *                       Optional. Options for configuring the service API wrapper.
      *
      *     @type string $serviceAddress
+     *           **Deprecated**. This option will be removed in a future major release. Please
+     *           utilize the `$apiEndpoint` option instead.
+     *     @type string $apiEndpoint
      *           The address of the API remote host. May optionally include the port, formatted
      *           as "<uri>:<port>". Default 'cloudscheduler.googleapis.com:443'.
      *     @type string|array|FetchAuthTokenInterface|CredentialsWrapper $credentials
@@ -304,7 +307,7 @@ public static function parseName($formattedName, $template = null)
      *           or `grpc`. Defaults to `grpc` if gRPC support is detected on the system.
      *           *Advanced usage*: Additionally, it is possible to pass in an already instantiated
      *           {@see \Google\ApiCore\Transport\TransportInterface} object. Note that when this
-     *           object is provided, any settings in $transportConfig, and any $serviceAddress
+     *           object is provided, any settings in $transportConfig, and any `$apiEndpoint`
      *           setting, will be ignored.
      *     @type array $transportConfig
      *           Configuration options that will be used to construct the transport. Options for

Scheduler/src/V1beta1/Gapic/CloudSchedulerGapicClient.php

@@ -126,7 +126,7 @@ private static function getClientDefaults()
     {
         return [
             'serviceName' => self::SERVICE_NAME,
-            'serviceAddress' => self::SERVICE_ADDRESS.':'.self::DEFAULT_SERVICE_PORT,
+            'apiEndpoint' => self::SERVICE_ADDRESS.':'.self::DEFAULT_SERVICE_PORT,
             'clientConfig' => __DIR__.'/../resources/cloud_scheduler_client_config.json',
             'descriptorsConfigPath' => __DIR__.'/../resources/cloud_scheduler_descriptor_config.php',
             'gcpApiConfigPath' => __DIR__.'/../resources/cloud_scheduler_grpc_config.json',
@@ -285,6 +285,9 @@ public static function parseName($formattedName, $template = null)
      *                       Optional. Options for configuring the service API wrapper.
      *
      *     @type string $serviceAddress
+     *           **Deprecated**. This option will be removed in a future major release. Please
+     *           utilize the `$apiEndpoint` option instead.
+     *     @type string $apiEndpoint
      *           The address of the API remote host. May optionally include the port, formatted
      *           as "<uri>:<port>". Default 'cloudscheduler.googleapis.com:443'.
      *     @type string|array|FetchAuthTokenInterface|CredentialsWrapper $credentials
@@ -312,7 +315,7 @@ public static function parseName($formattedName, $template = null)
      *           or `grpc`. Defaults to `grpc` if gRPC support is detected on the system.
      *           *Advanced usage*: Additionally, it is possible to pass in an already instantiated
      *           {@see \Google\ApiCore\Transport\TransportInterface} object. Note that when this
-     *           object is provided, any settings in $transportConfig, and any $serviceAddress
+     *           object is provided, any settings in $transportConfig, and any `$apiEndpoint`
      *           setting, will be ignored.
      *     @type array $transportConfig
      *           Configuration options that will be used to construct the transport. Options for

Scheduler/synth.metadata

@@ -1,19 +1,19 @@
 {
-  "updateTime": "2019-05-14T23:21:20.820042Z",
+  "updateTime": "2019-08-07T18:03:54.335266Z",
   "sources": [
     {
       "generator": {
         "name": "artman",
-        "version": "0.19.0",
-        "dockerImage": "googleapis/artman@sha256:d3df563538225ac6caac45d8ad86499500211d1bcb2536955a6dbda15e1b368e"
+        "version": "0.29.1",
+        "dockerImage": "googleapis/artman@sha256:b2a73f4dda03ef8fcaa973e3ba26d0cf34091f6c22c70add663af325931aef4d"
       }
     },
     {
       "git": {
         "name": "googleapis",
         "remote": "https://github.com/googleapis/googleapis.git",
-        "sha": "275cdfcdc3188a60456f43acd139b8cc037379f4",
-        "internalRef": "248217300"
+        "sha": "3a1b46a6668194a527e532a2c355b404c79b0e6a",
+        "internalRef": "262167956"
       }
     }
   ],

Scheduler/tests/Unit/V1/CloudSchedulerClientTest.php

@@ -36,7 +36,7 @@
 use stdClass;
 
 /**
- * @group cloudscheduler
+ * @group scheduler
  * @group gapic
  */
 class CloudSchedulerClientTest extends GeneratedTest
@@ -49,15 +49,23 @@ private function createTransport($deserialize = null)
         return new MockTransport($deserialize);
     }
 
+    /**
+     * @return CredentialsWrapper
+     */
+    private function createCredentials()
+    {
+        return $this->getMockBuilder(CredentialsWrapper::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+    }
+
     /**
      * @return CloudSchedulerClient
      */
     private function createClient(array $options = [])
     {
         $options += [
-            'credentials' => $this->getMockBuilder(CredentialsWrapper::class)
-                ->disableOriginalConstructor()
-                ->getMock(),
+            'credentials' => $this->createCredentials(),
         ];
 
         return new CloudSchedulerClient($options);

Scheduler/tests/Unit/V1beta1/CloudSchedulerClientTest.php

@@ -35,7 +35,7 @@
 use stdClass;
 
 /**
- * @group cloudscheduler
+ * @group scheduler
  * @group gapic
  */
 class CloudSchedulerClientTest extends GeneratedTest
@@ -48,15 +48,23 @@ private function createTransport($deserialize = null)
         return new MockTransport($deserialize);
     }
 
+    /**
+     * @return CredentialsWrapper
+     */
+    private function createCredentials()
+    {
+        return $this->getMockBuilder(CredentialsWrapper::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+    }
+
     /**
      * @return CloudSchedulerClient
      */
     private function createClient(array $options = [])
     {
         $options += [
-            'credentials' => $this->getMockBuilder(CredentialsWrapper::class)
-                ->disableOriginalConstructor()
-                ->getMock(),
+            'credentials' => $this->createCredentials(),
         ];
 
         return new CloudSchedulerClient($options);