feat: add new client surface to preview clients (#6204)

chore: update the gapic generator to 1.7.4
PiperOrigin-RevId: 530731364
Source-Link: googleapis/googleapis@cbddac7
Source-Link: googleapis/googleapis-gen@539cbcf
Copy-Tag: eyJwIjoiUHJpdmF0ZUNhdGFsb2cvLk93bEJvdC55YW1sIiwiaCI6IjUzOWNiY2Y0YjQxZTg4NmQ1MmEzZTJkODJhYjlmZGM0NDZiYTBlMDQifQ==
Copy-Tag: eyJwIjoiUmVjb21tZW5kYXRpb25FbmdpbmUvLk93bEJvdC55YW1sIiwiaCI6IjUzOWNiY2Y0YjQxZTg4NmQ1MmEzZTJkODJhYjlmZGM0NDZiYTBlMDQifQ==
Copy-Tag: eyJwIjoiUnVuLy5Pd2xCb3QueWFtbCIsImgiOiI1MzljYmNmNGI0MWU4ODZkNTJhM2UyZDgyYWI5ZmRjNDQ2YmEwZTA0In0=
Copy-Tag: eyJwIjoiU2VjdXJpdHlQdWJsaWNDQS8uT3dsQm90LnlhbWwiLCJoIjoiNTM5Y2JjZjRiNDFlODg2ZDUyYTNlMmQ4MmFiOWZkYzQ0NmJhMGUwNCJ9
Copy-Tag: eyJwIjoiU3RvcmFnZUluc2lnaHRzLy5Pd2xCb3QueWFtbCIsImgiOiI1MzljYmNmNGI0MWU4ODZkNTJhM2UyZDgyYWI5ZmRjNDQ2YmEwZTA0In0=
Copy-Tag: eyJwIjoiVmlkZW9MaXZlU3RyZWFtLy5Pd2xCb3QueWFtbCIsImgiOiI1MzljYmNmNGI0MWU4ODZkNTJhM2UyZDgyYWI5ZmRjNDQ2YmEwZTA0In0=
Copy-Tag: eyJwIjoiVmlkZW9TdGl0Y2hlci8uT3dsQm90LnlhbWwiLCJoIjoiNTM5Y2JjZjRiNDFlODg2ZDUyYTNlMmQ4MmFiOWZkYzQ0NmJhMGUwNCJ9
Copy-Tag: eyJwIjoiVmlkZW9UcmFuc2NvZGVyLy5Pd2xCb3QueWFtbCIsImgiOiI1MzljYmNmNGI0MWU4ODZkNTJhM2UyZDgyYWI5ZmRjNDQ2YmEwZTA0In0=
Copy-Tag: eyJwIjoiVm1NaWdyYXRpb24vLk93bEJvdC55YW1sIiwiaCI6IjUzOWNiY2Y0YjQxZTg4NmQ1MmEzZTJkODJhYjlmZGM0NDZiYTBlMDQifQ==
Copy-Tag: eyJwIjoiVm13YXJlRW5naW5lLy5Pd2xCb3QueWFtbCIsImgiOiI1MzljYmNmNGI0MWU4ODZkNTJhM2UyZDgyYWI5ZmRjNDQ2YmEwZTA0In0=

PrivateCatalog/samples/V1beta1/PrivateCatalogClient/search_catalogs.php

@@ -26,7 +26,8 @@
 use Google\ApiCore\ApiException;
 use Google\ApiCore\PagedListResponse;
 use Google\Cloud\PrivateCatalog\V1beta1\Catalog;
-use Google\Cloud\PrivateCatalog\V1beta1\PrivateCatalogClient;
+use Google\Cloud\PrivateCatalog\V1beta1\Client\PrivateCatalogClient;
+use Google\Cloud\PrivateCatalog\V1beta1\SearchCatalogsRequest;
 
 /**
  * Search [Catalog][google.cloud.privatecatalog.v1beta1.Catalog] resources that consumers have access to, within the
@@ -43,10 +44,14 @@ function search_catalogs_sample(string $resource): void
     // Create a client.
     $privateCatalogClient = new PrivateCatalogClient();
 
+    // Prepare the request message.
+    $request = (new SearchCatalogsRequest())
+        ->setResource($resource);
+
     // Call the API and handle any network failures.
     try {
         /** @var PagedListResponse $response */
-        $response = $privateCatalogClient->searchCatalogs($resource);
+        $response = $privateCatalogClient->searchCatalogs($request);
 
         /** @var Catalog $element */
         foreach ($response as $element) {

PrivateCatalog/samples/V1beta1/PrivateCatalogClient/search_products.php

@@ -25,8 +25,9 @@
 // [START cloudprivatecatalog_v1beta1_generated_PrivateCatalog_SearchProducts_sync]
 use Google\ApiCore\ApiException;
 use Google\ApiCore\PagedListResponse;
-use Google\Cloud\PrivateCatalog\V1beta1\PrivateCatalogClient;
+use Google\Cloud\PrivateCatalog\V1beta1\Client\PrivateCatalogClient;
 use Google\Cloud\PrivateCatalog\V1beta1\Product;
+use Google\Cloud\PrivateCatalog\V1beta1\SearchProductsRequest;
 
 /**
  * Search [Product][google.cloud.privatecatalog.v1beta1.Product] resources that consumers have access to, within the
@@ -40,10 +41,14 @@ function search_products_sample(string $resource): void
     // Create a client.
     $privateCatalogClient = new PrivateCatalogClient();
 
+    // Prepare the request message.
+    $request = (new SearchProductsRequest())
+        ->setResource($resource);
+
     // Call the API and handle any network failures.
     try {
         /** @var PagedListResponse $response */
-        $response = $privateCatalogClient->searchProducts($resource);
+        $response = $privateCatalogClient->searchProducts($request);
 
         /** @var Product $element */
         foreach ($response as $element) {

PrivateCatalog/samples/V1beta1/PrivateCatalogClient/search_versions.php

@@ -25,7 +25,8 @@
 // [START cloudprivatecatalog_v1beta1_generated_PrivateCatalog_SearchVersions_sync]
 use Google\ApiCore\ApiException;
 use Google\ApiCore\PagedListResponse;
-use Google\Cloud\PrivateCatalog\V1beta1\PrivateCatalogClient;
+use Google\Cloud\PrivateCatalog\V1beta1\Client\PrivateCatalogClient;
+use Google\Cloud\PrivateCatalog\V1beta1\SearchVersionsRequest;
 use Google\Cloud\PrivateCatalog\V1beta1\Version;
 
 /**
@@ -47,10 +48,15 @@ function search_versions_sample(string $resource, string $query): void
     // Create a client.
     $privateCatalogClient = new PrivateCatalogClient();
 
+    // Prepare the request message.
+    $request = (new SearchVersionsRequest())
+        ->setResource($resource)
+        ->setQuery($query);
+
     // Call the API and handle any network failures.
     try {
         /** @var PagedListResponse $response */
-        $response = $privateCatalogClient->searchVersions($resource, $query);
+        $response = $privateCatalogClient->searchVersions($request);
 
         /** @var Version $element */
         foreach ($response as $element) {

PrivateCatalog/src/V1beta1/Client/BaseClient/PrivateCatalogBaseClient.php

@@ -0,0 +1,271 @@
+<?php
+/*
+ * 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.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/*
+ * GENERATED CODE WARNING
+ * Generated by gapic-generator-php from the file
+ * https://github.com/googleapis/googleapis/blob/master/google/cloud/privatecatalog/v1beta1/private_catalog.proto
+ * Updates to the above are reflected here through a refresh process.
+ *
+ * @experimental
+ */
+
+namespace Google\Cloud\PrivateCatalog\V1beta1\Client\BaseClient;
+
+use Google\ApiCore\ApiException;
+use Google\ApiCore\CredentialsWrapper;
+use Google\ApiCore\GapicClientTrait;
+use Google\ApiCore\PagedListResponse;
+use Google\ApiCore\RetrySettings;
+use Google\ApiCore\Transport\TransportInterface;
+use Google\ApiCore\ValidationException;
+use Google\Auth\FetchAuthTokenInterface;
+use Google\Cloud\PrivateCatalog\V1beta1\SearchCatalogsRequest;
+use Google\Cloud\PrivateCatalog\V1beta1\SearchProductsRequest;
+use Google\Cloud\PrivateCatalog\V1beta1\SearchVersionsRequest;
+use GuzzleHttp\Promise\PromiseInterface;
+
+/**
+ * Service Description: `PrivateCatalog` allows catalog consumers to retrieve `Catalog`, `Product`
+ * and `Version` resources under a target resource context.
+ *
+ * `Catalog` is computed based on the [Association][]s linked to the target
+ * resource and its ancestors. Each association's
+ * [google.cloud.privatecatalogproducer.v1beta.Catalog][] is transformed into a
+ * `Catalog`. If multiple associations have the same parent
+ * [google.cloud.privatecatalogproducer.v1beta.Catalog][], they are
+ * de-duplicated into one `Catalog`. Users must have
+ * `cloudprivatecatalog.catalogTargets.get` IAM permission on the resource
+ * context in order to access catalogs. `Catalog` contains the resource name and
+ * a subset of data of the original
+ * [google.cloud.privatecatalogproducer.v1beta.Catalog][].
+ *
+ * `Product` is child resource of the catalog. A `Product` contains the resource
+ * name and a subset of the data of the original
+ * [google.cloud.privatecatalogproducer.v1beta.Product][].
+ *
+ * `Version` is child resource of the product. A `Version` contains the resource
+ * name and a subset of the data of the original
+ * [google.cloud.privatecatalogproducer.v1beta.Version][].
+ *
+ * This class provides the ability to make remote calls to the backing service through method
+ * calls that map to API methods.
+ *
+ * This class is currently experimental and may be subject to changes.
+ *
+ * @experimental
+ *
+ * @internal
+ *
+ * @method PromiseInterface searchCatalogsAsync(SearchCatalogsRequest $request, array $optionalArgs = [])
+ * @method PromiseInterface searchProductsAsync(SearchProductsRequest $request, array $optionalArgs = [])
+ * @method PromiseInterface searchVersionsAsync(SearchVersionsRequest $request, array $optionalArgs = [])
+ */
+abstract class PrivateCatalogBaseClient
+{
+    use GapicClientTrait;
+
+    /** The name of the service. */
+    private const SERVICE_NAME = 'google.cloud.privatecatalog.v1beta1.PrivateCatalog';
+
+    /** The default address of the service. */
+    private const SERVICE_ADDRESS = 'cloudprivatecatalog.googleapis.com';
+
+    /** The default port of the service. */
+    private const DEFAULT_SERVICE_PORT = 443;
+
+    /** The name of the code generator, to be included in the agent header. */
+    private const CODEGEN_NAME = 'gapic';
+
+    /** The default scopes required by the service. */
+    public static $serviceScopes = [
+        'https://www.googleapis.com/auth/cloud-platform',
+    ];
+
+    private static function getClientDefaults()
+    {
+        return [
+            'serviceName' => self::SERVICE_NAME,
+            'apiEndpoint' => self::SERVICE_ADDRESS . ':' . self::DEFAULT_SERVICE_PORT,
+            'clientConfig' => __DIR__ . '/../../resources/private_catalog_client_config.json',
+            'descriptorsConfigPath' => __DIR__ . '/../../resources/private_catalog_descriptor_config.php',
+            'gcpApiConfigPath' => __DIR__ . '/../../resources/private_catalog_grpc_config.json',
+            'credentialsConfig' => [
+                'defaultScopes' => self::$serviceScopes,
+            ],
+            'transportConfig' => [
+                'rest' => [
+                    'restClientConfigPath' => __DIR__ . '/../../resources/private_catalog_rest_client_config.php',
+                ],
+            ],
+        ];
+    }
+
+    /**
+     * Constructor.
+     *
+     * @param array $options {
+     *     Optional. Options for configuring the service API wrapper.
+     *
+     *     @type string $apiEndpoint
+     *           The address of the API remote host. May optionally include the port, formatted
+     *           as "<uri>:<port>". Default 'cloudprivatecatalog.googleapis.com:443'.
+     *     @type string|array|FetchAuthTokenInterface|CredentialsWrapper $credentials
+     *           The credentials to be used by the client to authorize API calls. This option
+     *           accepts either a path to a credentials file, or a decoded credentials file as a
+     *           PHP array.
+     *           *Advanced usage*: In addition, this option can also accept a pre-constructed
+     *           {@see \Google\Auth\FetchAuthTokenInterface} object or
+     *           {@see \Google\ApiCore\CredentialsWrapper} object. Note that when one of these
+     *           objects are provided, any settings in $credentialsConfig will be ignored.
+     *     @type array $credentialsConfig
+     *           Options used to configure credentials, including auth token caching, for the
+     *           client. For a full list of supporting configuration options, see
+     *           {@see \Google\ApiCore\CredentialsWrapper::build()} .
+     *     @type bool $disableRetries
+     *           Determines whether or not retries defined by the client configuration should be
+     *           disabled. Defaults to `false`.
+     *     @type string|array $clientConfig
+     *           Client method configuration, including retry settings. This option can be either
+     *           a path to a JSON file, or a PHP array containing the decoded JSON data. By
+     *           default this settings points to the default client config file, which is
+     *           provided in the resources folder.
+     *     @type string|TransportInterface $transport
+     *           The transport used for executing network requests. May be either the string
+     *           `rest` 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
+     *           $apiEndpoint setting, will be ignored.
+     *     @type array $transportConfig
+     *           Configuration options that will be used to construct the transport. Options for
+     *           each supported transport type should be passed in a key for that transport. For
+     *           example:
+     *           $transportConfig = [
+     *               'grpc' => [...],
+     *               'rest' => [...],
+     *           ];
+     *           See the {@see \Google\ApiCore\Transport\GrpcTransport::build()} and
+     *           {@see \Google\ApiCore\Transport\RestTransport::build()} methods for the
+     *           supported options.
+     *     @type callable $clientCertSource
+     *           A callable which returns the client cert as a string. This can be used to
+     *           provide a certificate and private key to the transport layer for mTLS.
+     * }
+     *
+     * @throws ValidationException
+     *
+     * @experimental
+     */
+    public function __construct(array $options = [])
+    {
+        $clientOptions = $this->buildClientOptions($options);
+        $this->setClientOptions($clientOptions);
+    }
+
+    /** Handles execution of the async variants for each documented method. */
+    public function __call($method, $args)
+    {
+        if (substr($method, -5) !== 'Async') {
+            trigger_error('Call to undefined method ' . __CLASS__ . "::$method()", E_USER_ERROR);
+        }
+
+        array_unshift($args, substr($method, 0, -5));
+        return call_user_func_array([$this, 'startAsyncCall'], $args);
+    }
+
+    /**
+     * Search [Catalog][google.cloud.privatecatalog.v1beta1.Catalog] resources that consumers have access to, within the
+     * scope of the consumer cloud resource hierarchy context.
+     *
+     * The async variant is {@see self::searchCatalogsAsync()} .
+     *
+     * @param SearchCatalogsRequest $request     A request to house fields associated with the call.
+     * @param array                 $callOptions {
+     *     Optional.
+     *
+     *     @type RetrySettings|array $retrySettings
+     *           Retry settings to use for this call. Can be a {@see RetrySettings} object, or an
+     *           associative array of retry settings parameters. See the documentation on
+     *           {@see RetrySettings} for example usage.
+     * }
+     *
+     * @return PagedListResponse
+     *
+     * @throws ApiException Thrown if the API call fails.
+     *
+     * @experimental
+     */
+    public function searchCatalogs(SearchCatalogsRequest $request, array $callOptions = []): PagedListResponse
+    {
+        return $this->startApiCall('SearchCatalogs', $request, $callOptions);
+    }
+
+    /**
+     * Search [Product][google.cloud.privatecatalog.v1beta1.Product] resources that consumers have access to, within the
+     * scope of the consumer cloud resource hierarchy context.
+     *
+     * The async variant is {@see self::searchProductsAsync()} .
+     *
+     * @param SearchProductsRequest $request     A request to house fields associated with the call.
+     * @param array                 $callOptions {
+     *     Optional.
+     *
+     *     @type RetrySettings|array $retrySettings
+     *           Retry settings to use for this call. Can be a {@see RetrySettings} object, or an
+     *           associative array of retry settings parameters. See the documentation on
+     *           {@see RetrySettings} for example usage.
+     * }
+     *
+     * @return PagedListResponse
+     *
+     * @throws ApiException Thrown if the API call fails.
+     *
+     * @experimental
+     */
+    public function searchProducts(SearchProductsRequest $request, array $callOptions = []): PagedListResponse
+    {
+        return $this->startApiCall('SearchProducts', $request, $callOptions);
+    }
+
+    /**
+     * Search [Version][google.cloud.privatecatalog.v1beta1.Version] resources that consumers have access to, within the
+     * scope of the consumer cloud resource hierarchy context.
+     *
+     * The async variant is {@see self::searchVersionsAsync()} .
+     *
+     * @param SearchVersionsRequest $request     A request to house fields associated with the call.
+     * @param array                 $callOptions {
+     *     Optional.
+     *
+     *     @type RetrySettings|array $retrySettings
+     *           Retry settings to use for this call. Can be a {@see RetrySettings} object, or an
+     *           associative array of retry settings parameters. See the documentation on
+     *           {@see RetrySettings} for example usage.
+     * }
+     *
+     * @return PagedListResponse
+     *
+     * @throws ApiException Thrown if the API call fails.
+     *
+     * @experimental
+     */
+    public function searchVersions(SearchVersionsRequest $request, array $callOptions = []): PagedListResponse
+    {
+        return $this->startApiCall('SearchVersions', $request, $callOptions);
+    }
+}

PrivateCatalog/src/V1beta1/Client/PrivateCatalogClient.php

@@ -0,0 +1,42 @@
+<?php
+/*
+ * 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.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/*
+ * GENERATED CODE WARNING
+ * Generated by gapic-generator-php from the file
+ * https://github.com/googleapis/googleapis/blob/master/google/cloud/privatecatalog/v1beta1/private_catalog.proto
+ * Updates to the above are reflected here through a refresh process.
+ *
+ * @experimental
+ */
+
+namespace Google\Cloud\PrivateCatalog\V1beta1\Client;
+
+use Google\Cloud\PrivateCatalog\V1beta1\Client\BaseClient\PrivateCatalogBaseClient;
+
+/**
+ * {@inheritdoc}
+ *
+ * This class is currently experimental and may be subject to changes.
+ *
+ * @experimental
+ */
+final class PrivateCatalogClient extends PrivateCatalogBaseClient
+{
+    // This class is intentionally empty, and is intended to hold manual additions to
+    // the generated {@see PrivateCatalogBaseClient} class.
+}