Add changes for grpc only clients and fix comment for the php doc

rules_php_gapic/php_gapic.bzl

@@ -55,7 +55,7 @@ def php_gapic_srcjar(
         rest_numeric_enums = False,
         generate_snippets = True,
         # Supported values validated and specified in src/Utils/MigrationMode.php.
-        migration_mode = "PRE_MIGRATION_SURFACE_ONLY", 
+        migration_mode = "PRE_MIGRATION_SURFACE_ONLY",
         generator_binary = Label("//rules_php_gapic:php_gapic_generator_binary"),
         **kwargs):
     plugin_file_args = {}
@@ -71,6 +71,8 @@ def php_gapic_srcjar(
         transport = "grpc+rest"
     if transport != "grpc+rest" and transport != "rest" and transport != "grpc":
         fail("Error: Only 'grpc+rest', 'rest' or `grpc` transports are supported")
+    if transport == "grpc" and migration_mode != "NEW_SURFACE_ONLY":
+        fail("Error: 'grpc' transport is only supported with 'NEW_SURFACE_ONLY' migration mode")
 
     # Set plugin arguments.
     plugin_args = ["metadata"]  # Generate the gapic_metadata.json file.

src/Generation/GapicClientGenerator.php

@@ -443,7 +443,7 @@ private function getClientDefaults(): PhpClassMember
 
         // TODO: Consolidate setting all the known array values together.
         // We do this here to maintain the existing sensible ordering.
-        if ($this->serviceDetails->transportType !== Transport::REST) {
+        if ($this->serviceDetails->transportType === Transport::GRPC_REST) {
             $clientDefaultValues['gcpApiConfigPath'] =
                 AST::concat(AST::__DIR__, "/../resources/{$this->serviceDetails->grpcConfigFilename}");
         }

src/Generation/GapicClientV2Generator.php

@@ -431,7 +431,7 @@ private function getClientDefaults(): PhpClassMember
 
         // TODO: Consolidate setting all the known array values together.
         // We do this here to maintain the existing sensible ordering.
-        if ($this->serviceDetails->transportType === Transport::GRPC_REST) {
+        if ($this->serviceDetails->transportType !== Transport::REST) {
             $clientDefaultValues['gcpApiConfigPath'] =
                 AST::concat(AST::__DIR__, "/../resources/{$this->serviceDetails->grpcConfigFilename}");
         }
@@ -548,16 +548,16 @@ private function construct(): PhpClassMember
                 AST::call(
                     $ctx->type(
                         Type::fromName(
-                            Transport::isRestOnly($transportType) ? 
+                            Transport::isRestOnly($transportType) ?
                                 RestTransport::class :
                                 GrpcTransport::class
                         ),
                         true
                     ),
                     AST::method('build')
                 )(),
-                Transport::isGRPCRest($transportType) ? 'and' : '',
-                Transport::isGRPCRest($transportType) ? 
+                Transport::isGrpcRest($transportType) ? 'and' : '',
+                Transport::isGrpcRest($transportType) ?
                     AST::call(
                         $ctx->type(
                             Type::fromName(RestTransport::class),
@@ -566,7 +566,7 @@ private function construct(): PhpClassMember
                         AST::method('build')
                     )()
                     : '',
-                Transport::isGRPCRest($transportType) ? 'methods ' : 'method ',
+                Transport::isGrpcRest($transportType) ? 'methods ' : 'method ',
                 'for the supported options.'
             );
         return AST::method('__construct')

src/Utils/Transport.php

@@ -55,7 +55,7 @@ public static function isGrpcOnly(int $transport): bool
         return Transport::compareTransports(Transport::GRPC, $transport);
     }
 
-    public static function isGRPCRest(int $transport): bool
+    public static function isGrpcRest(int $transport): bool
     {
         return Transport::compareTransports(Transport::GRPC_REST, $transport);
     }

tests/Integration/BUILD.bazel

@@ -353,7 +353,7 @@ php_gapic_library(
     gapic_yaml = "apis/redis/v1/redis_gapic.yaml",
     grpc_service_config = "@com_google_googleapis//google/cloud/redis/v1:redis_grpc_service_config.json",
     service_yaml = "@com_google_googleapis//google/cloud/redis/v1:redis_v1.yaml",
-    migration_mode = "MIGRATION_MODE_UNSPECIFIED",
+    migration_mode = "NEW_SURFACE_ONLY",
     transport = "grpc",
     deps = [
         ":redis_php_grpc",

tests/Integration/goldens/redis/samples/V1/CloudRedisClient/create_instance.php

@@ -25,7 +25,8 @@
 // [START redis_v1_generated_CloudRedis_CreateInstance_sync]
 use Google\ApiCore\ApiException;
 use Google\ApiCore\OperationResponse;
-use Google\Cloud\Redis\V1\CloudRedisClient;
+use Google\Cloud\Redis\V1\Client\CloudRedisClient;
+use Google\Cloud\Redis\V1\CreateInstanceRequest;
 use Google\Cloud\Redis\V1\Instance;
 use Google\Cloud\Redis\V1\Instance\Tier;
 use Google\Rpc\Status;
@@ -80,16 +81,20 @@ function create_instance_sample(
     // Create a client.
     $cloudRedisClient = new CloudRedisClient();
 
-    // Prepare any non-scalar elements to be passed along with the request.
+    // Prepare the request message.
     $instance = (new Instance())
         ->setName($instanceName)
         ->setTier($instanceTier)
         ->setMemorySizeGb($instanceMemorySizeGb);
+    $request = (new CreateInstanceRequest())
+        ->setParent($formattedParent)
+        ->setInstanceId($instanceId)
+        ->setInstance($instance);
 
     // Call the API and handle any network failures.
     try {
         /** @var OperationResponse $response */
-        $response = $cloudRedisClient->createInstance($formattedParent, $instanceId, $instance);
+        $response = $cloudRedisClient->createInstance($request);
         $response->pollUntilComplete();
 
         if ($response->operationSucceeded()) {

tests/Integration/goldens/redis/samples/V1/CloudRedisClient/delete_instance.php

@@ -25,7 +25,8 @@
 // [START redis_v1_generated_CloudRedis_DeleteInstance_sync]
 use Google\ApiCore\ApiException;
 use Google\ApiCore\OperationResponse;
-use Google\Cloud\Redis\V1\CloudRedisClient;
+use Google\Cloud\Redis\V1\Client\CloudRedisClient;
+use Google\Cloud\Redis\V1\DeleteInstanceRequest;
 use Google\Rpc\Status;
 
 /**
@@ -42,10 +43,14 @@ function delete_instance_sample(string $formattedName): void
     // Create a client.
     $cloudRedisClient = new CloudRedisClient();
 
+    // Prepare the request message.
+    $request = (new DeleteInstanceRequest())
+        ->setName($formattedName);
+
     // Call the API and handle any network failures.
     try {
         /** @var OperationResponse $response */
-        $response = $cloudRedisClient->deleteInstance($formattedName);
+        $response = $cloudRedisClient->deleteInstance($request);
         $response->pollUntilComplete();
 
         if ($response->operationSucceeded()) {

tests/Integration/goldens/redis/samples/V1/CloudRedisClient/export_instance.php

@@ -25,7 +25,8 @@
 // [START redis_v1_generated_CloudRedis_ExportInstance_sync]
 use Google\ApiCore\ApiException;
 use Google\ApiCore\OperationResponse;
-use Google\Cloud\Redis\V1\CloudRedisClient;
+use Google\Cloud\Redis\V1\Client\CloudRedisClient;
+use Google\Cloud\Redis\V1\ExportInstanceRequest;
 use Google\Cloud\Redis\V1\Instance;
 use Google\Cloud\Redis\V1\OutputConfig;
 use Google\Rpc\Status;
@@ -47,13 +48,16 @@ function export_instance_sample(string $name): void
     // Create a client.
     $cloudRedisClient = new CloudRedisClient();
 
-    // Prepare any non-scalar elements to be passed along with the request.
+    // Prepare the request message.
     $outputConfig = new OutputConfig();
+    $request = (new ExportInstanceRequest())
+        ->setName($name)
+        ->setOutputConfig($outputConfig);
 
     // Call the API and handle any network failures.
     try {
         /** @var OperationResponse $response */
-        $response = $cloudRedisClient->exportInstance($name, $outputConfig);
+        $response = $cloudRedisClient->exportInstance($request);
         $response->pollUntilComplete();
 
         if ($response->operationSucceeded()) {

tests/Integration/goldens/redis/samples/V1/CloudRedisClient/failover_instance.php

@@ -25,7 +25,8 @@
 // [START redis_v1_generated_CloudRedis_FailoverInstance_sync]
 use Google\ApiCore\ApiException;
 use Google\ApiCore\OperationResponse;
-use Google\Cloud\Redis\V1\CloudRedisClient;
+use Google\Cloud\Redis\V1\Client\CloudRedisClient;
+use Google\Cloud\Redis\V1\FailoverInstanceRequest;
 use Google\Cloud\Redis\V1\Instance;
 use Google\Rpc\Status;
 
@@ -43,10 +44,14 @@ function failover_instance_sample(string $formattedName): void
     // Create a client.
     $cloudRedisClient = new CloudRedisClient();
 
+    // Prepare the request message.
+    $request = (new FailoverInstanceRequest())
+        ->setName($formattedName);
+
     // Call the API and handle any network failures.
     try {
         /** @var OperationResponse $response */
-        $response = $cloudRedisClient->failoverInstance($formattedName);
+        $response = $cloudRedisClient->failoverInstance($request);
         $response->pollUntilComplete();
 
         if ($response->operationSucceeded()) {

tests/Integration/goldens/redis/samples/V1/CloudRedisClient/get_instance.php

@@ -24,7 +24,8 @@
 
 // [START redis_v1_generated_CloudRedis_GetInstance_sync]
 use Google\ApiCore\ApiException;
-use Google\Cloud\Redis\V1\CloudRedisClient;
+use Google\Cloud\Redis\V1\Client\CloudRedisClient;
+use Google\Cloud\Redis\V1\GetInstanceRequest;
 use Google\Cloud\Redis\V1\Instance;
 
 /**
@@ -40,10 +41,14 @@ function get_instance_sample(string $formattedName): void
     // Create a client.
     $cloudRedisClient = new CloudRedisClient();
 
+    // Prepare the request message.
+    $request = (new GetInstanceRequest())
+        ->setName($formattedName);
+
     // Call the API and handle any network failures.
     try {
         /** @var Instance $response */
-        $response = $cloudRedisClient->getInstance($formattedName);
+        $response = $cloudRedisClient->getInstance($request);
         printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
     } catch (ApiException $ex) {
         printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());

tests/Integration/goldens/redis/samples/V1/CloudRedisClient/get_instance_auth_string.php

@@ -24,7 +24,8 @@
 
 // [START redis_v1_generated_CloudRedis_GetInstanceAuthString_sync]
 use Google\ApiCore\ApiException;
-use Google\Cloud\Redis\V1\CloudRedisClient;
+use Google\Cloud\Redis\V1\Client\CloudRedisClient;
+use Google\Cloud\Redis\V1\GetInstanceAuthStringRequest;
 use Google\Cloud\Redis\V1\InstanceAuthString;
 
 /**
@@ -42,10 +43,14 @@ function get_instance_auth_string_sample(string $formattedName): void
     // Create a client.
     $cloudRedisClient = new CloudRedisClient();
 
+    // Prepare the request message.
+    $request = (new GetInstanceAuthStringRequest())
+        ->setName($formattedName);
+
     // Call the API and handle any network failures.
     try {
         /** @var InstanceAuthString $response */
-        $response = $cloudRedisClient->getInstanceAuthString($formattedName);
+        $response = $cloudRedisClient->getInstanceAuthString($request);
         printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
     } catch (ApiException $ex) {
         printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());

tests/Integration/goldens/redis/samples/V1/CloudRedisClient/get_location.php

@@ -24,8 +24,9 @@
 
 // [START redis_v1_generated_CloudRedis_GetLocation_sync]
 use Google\ApiCore\ApiException;
+use Google\Cloud\Location\GetLocationRequest;
 use Google\Cloud\Location\Location;
-use Google\Cloud\Redis\V1\CloudRedisClient;
+use Google\Cloud\Redis\V1\Client\CloudRedisClient;
 
 /**
  * Gets information about a location.
@@ -41,10 +42,13 @@ function get_location_sample(): void
     // Create a client.
     $cloudRedisClient = new CloudRedisClient();
 
+    // Prepare the request message.
+    $request = new GetLocationRequest();
+
     // Call the API and handle any network failures.
     try {
         /** @var Location $response */
-        $response = $cloudRedisClient->getLocation();
+        $response = $cloudRedisClient->getLocation($request);
         printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
     } catch (ApiException $ex) {
         printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());

tests/Integration/goldens/redis/samples/V1/CloudRedisClient/import_instance.php

@@ -25,7 +25,8 @@
 // [START redis_v1_generated_CloudRedis_ImportInstance_sync]
 use Google\ApiCore\ApiException;
 use Google\ApiCore\OperationResponse;
-use Google\Cloud\Redis\V1\CloudRedisClient;
+use Google\Cloud\Redis\V1\Client\CloudRedisClient;
+use Google\Cloud\Redis\V1\ImportInstanceRequest;
 use Google\Cloud\Redis\V1\InputConfig;
 use Google\Cloud\Redis\V1\Instance;
 use Google\Rpc\Status;
@@ -49,13 +50,16 @@ function import_instance_sample(string $name): void
     // Create a client.
     $cloudRedisClient = new CloudRedisClient();
 
-    // Prepare any non-scalar elements to be passed along with the request.
+    // Prepare the request message.
     $inputConfig = new InputConfig();
+    $request = (new ImportInstanceRequest())
+        ->setName($name)
+        ->setInputConfig($inputConfig);
 
     // Call the API and handle any network failures.
     try {
         /** @var OperationResponse $response */
-        $response = $cloudRedisClient->importInstance($name, $inputConfig);
+        $response = $cloudRedisClient->importInstance($request);
         $response->pollUntilComplete();
 
         if ($response->operationSucceeded()) {

tests/Integration/goldens/redis/samples/V1/CloudRedisClient/list_instances.php

@@ -25,8 +25,9 @@
 // [START redis_v1_generated_CloudRedis_ListInstances_sync]
 use Google\ApiCore\ApiException;
 use Google\ApiCore\PagedListResponse;
-use Google\Cloud\Redis\V1\CloudRedisClient;
+use Google\Cloud\Redis\V1\Client\CloudRedisClient;
 use Google\Cloud\Redis\V1\Instance;
+use Google\Cloud\Redis\V1\ListInstancesRequest;
 
 /**
  * Lists all Redis instances owned by a project in either the specified
@@ -49,10 +50,14 @@ function list_instances_sample(string $formattedParent): void
     // Create a client.
     $cloudRedisClient = new CloudRedisClient();
 
+    // Prepare the request message.
+    $request = (new ListInstancesRequest())
+        ->setParent($formattedParent);
+
     // Call the API and handle any network failures.
     try {
         /** @var PagedListResponse $response */
-        $response = $cloudRedisClient->listInstances($formattedParent);
+        $response = $cloudRedisClient->listInstances($request);
 
         /** @var Instance $element */
         foreach ($response as $element) {

tests/Integration/goldens/redis/samples/V1/CloudRedisClient/list_locations.php

@@ -25,8 +25,9 @@
 // [START redis_v1_generated_CloudRedis_ListLocations_sync]
 use Google\ApiCore\ApiException;
 use Google\ApiCore\PagedListResponse;
+use Google\Cloud\Location\ListLocationsRequest;
 use Google\Cloud\Location\Location;
-use Google\Cloud\Redis\V1\CloudRedisClient;
+use Google\Cloud\Redis\V1\Client\CloudRedisClient;
 
 /**
  * Lists information about the supported locations for this service.
@@ -42,10 +43,13 @@ function list_locations_sample(): void
     // Create a client.
     $cloudRedisClient = new CloudRedisClient();
 
+    // Prepare the request message.
+    $request = new ListLocationsRequest();
+
     // Call the API and handle any network failures.
     try {
         /** @var PagedListResponse $response */
-        $response = $cloudRedisClient->listLocations();
+        $response = $cloudRedisClient->listLocations($request);
 
         /** @var Location $element */
         foreach ($response as $element) {

tests/Integration/goldens/redis/samples/V1/CloudRedisClient/reschedule_maintenance.php

@@ -25,8 +25,9 @@
 // [START redis_v1_generated_CloudRedis_RescheduleMaintenance_sync]
 use Google\ApiCore\ApiException;
 use Google\ApiCore\OperationResponse;
-use Google\Cloud\Redis\V1\CloudRedisClient;
+use Google\Cloud\Redis\V1\Client\CloudRedisClient;
 use Google\Cloud\Redis\V1\Instance;
+use Google\Cloud\Redis\V1\RescheduleMaintenanceRequest;
 use Google\Cloud\Redis\V1\RescheduleMaintenanceRequest\RescheduleType;
 use Google\Rpc\Status;
 
@@ -46,10 +47,15 @@ function reschedule_maintenance_sample(string $formattedName, int $rescheduleTyp
     // Create a client.
     $cloudRedisClient = new CloudRedisClient();
 
+    // Prepare the request message.
+    $request = (new RescheduleMaintenanceRequest())
+        ->setName($formattedName)
+        ->setRescheduleType($rescheduleType);
+
     // Call the API and handle any network failures.
     try {
         /** @var OperationResponse $response */
-        $response = $cloudRedisClient->rescheduleMaintenance($formattedName, $rescheduleType);
+        $response = $cloudRedisClient->rescheduleMaintenance($request);
         $response->pollUntilComplete();
 
         if ($response->operationSucceeded()) {