<?php
/*
 * Copyright 2025 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/dialogflow/v2/generator_evaluation.proto
 * Updates to the above are reflected here through a refresh process.
 */

namespace Google\Cloud\Dialogflow\V2\Client;

use Google\ApiCore\ApiException;
use Google\ApiCore\CredentialsWrapper;
use Google\ApiCore\GapicClientTrait;
use Google\ApiCore\OperationResponse;
use Google\ApiCore\Options\ClientOptions;
use Google\ApiCore\PagedListResponse;
use Google\ApiCore\ResourceHelperTrait;
use Google\ApiCore\RetrySettings;
use Google\ApiCore\Transport\TransportInterface;
use Google\ApiCore\ValidationException;
use Google\Auth\FetchAuthTokenInterface;
use Google\Cloud\Dialogflow\V2\CreateGeneratorEvaluationRequest;
use Google\Cloud\Dialogflow\V2\DeleteGeneratorEvaluationRequest;
use Google\Cloud\Dialogflow\V2\GeneratorEvaluation;
use Google\Cloud\Dialogflow\V2\GetGeneratorEvaluationRequest;
use Google\Cloud\Dialogflow\V2\ListGeneratorEvaluationsRequest;
use Google\Cloud\Location\GetLocationRequest;
use Google\Cloud\Location\ListLocationsRequest;
use Google\Cloud\Location\Location;
use Google\LongRunning\Client\OperationsClient;
use Google\LongRunning\Operation;
use GuzzleHttp\Promise\PromiseInterface;
use Psr\Log\LoggerInterface;

/**
 * Service Description: Service for managing generator evaluations.
 *
 * This class provides the ability to make remote calls to the backing service through method
 * calls that map to API methods.
 *
 * Many parameters require resource names to be formatted in a particular way. To
 * assist with these names, this class includes a format method for each type of
 * name, and additionally a parseName method to extract the individual identifiers
 * contained within formatted names that are returned by the API.
 *
 * @method PromiseInterface<OperationResponse> createGeneratorEvaluationAsync(CreateGeneratorEvaluationRequest $request, array $optionalArgs = [])
 * @method PromiseInterface<void> deleteGeneratorEvaluationAsync(DeleteGeneratorEvaluationRequest $request, array $optionalArgs = [])
 * @method PromiseInterface<GeneratorEvaluation> getGeneratorEvaluationAsync(GetGeneratorEvaluationRequest $request, array $optionalArgs = [])
 * @method PromiseInterface<PagedListResponse> listGeneratorEvaluationsAsync(ListGeneratorEvaluationsRequest $request, array $optionalArgs = [])
 * @method PromiseInterface<Location> getLocationAsync(GetLocationRequest $request, array $optionalArgs = [])
 * @method PromiseInterface<PagedListResponse> listLocationsAsync(ListLocationsRequest $request, array $optionalArgs = [])
 */
final class GeneratorEvaluationsClient
{
    use GapicClientTrait;
    use ResourceHelperTrait;

    /** The name of the service. */
    private const SERVICE_NAME = 'google.cloud.dialogflow.v2.GeneratorEvaluations';

    /**
     * The default address of the service.
     *
     * @deprecated SERVICE_ADDRESS_TEMPLATE should be used instead.
     */
    private const SERVICE_ADDRESS = 'dialogflow.googleapis.com';

    /** The address template of the service. */
    private const SERVICE_ADDRESS_TEMPLATE = 'dialogflow.UNIVERSE_DOMAIN';

    /** 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',
        'https://www.googleapis.com/auth/dialogflow',
    ];

    private $operationsClient;

    private static function getClientDefaults()
    {
        return [
            'serviceName' => self::SERVICE_NAME,
            'apiEndpoint' => self::SERVICE_ADDRESS . ':' . self::DEFAULT_SERVICE_PORT,
            'clientConfig' => __DIR__ . '/../resources/generator_evaluations_client_config.json',
            'descriptorsConfigPath' => __DIR__ . '/../resources/generator_evaluations_descriptor_config.php',
            'gcpApiConfigPath' => __DIR__ . '/../resources/generator_evaluations_grpc_config.json',
            'credentialsConfig' => [
                'defaultScopes' => self::$serviceScopes,
            ],
            'transportConfig' => [
                'rest' => [
                    'restClientConfigPath' => __DIR__ . '/../resources/generator_evaluations_rest_client_config.php',
                ],
            ],
        ];
    }

    /**
     * Return an OperationsClient object with the same endpoint as $this.
     *
     * @return OperationsClient
     */
    public function getOperationsClient()
    {
        return $this->operationsClient;
    }

    /**
     * Resume an existing long running operation that was previously started by a long
     * running API method. If $methodName is not provided, or does not match a long
     * running API method, then the operation can still be resumed, but the
     * OperationResponse object will not deserialize the final response.
     *
     * @param string $operationName The name of the long running operation
     * @param string $methodName    The name of the method used to start the operation
     *
     * @return OperationResponse
     */
    public function resumeOperation($operationName, $methodName = null)
    {
        $options = $this->descriptors[$methodName]['longRunning'] ?? [];
        $operation = new OperationResponse($operationName, $this->getOperationsClient(), $options);
        $operation->reload();
        return $operation;
    }

    /**
     * Create the default operation client for the service.
     *
     * @param array $options ClientOptions for the client.
     *
     * @return OperationsClient
     */
    private function createOperationsClient(array $options)
    {
        // Unset client-specific configuration options
        unset($options['serviceName'], $options['clientConfig'], $options['descriptorsConfigPath']);

        if (isset($options['operationsClient'])) {
            return $options['operationsClient'];
        }

        return new OperationsClient($options);
    }

    /**
     * Formats a string containing the fully-qualified path to represent a app
     * resource.
     *
     * @param string $project
     * @param string $location
     * @param string $app
     *
     * @return string The formatted app resource.
     */
    public static function appName(string $project, string $location, string $app): string
    {
        return self::getPathTemplate('app')->render([
            'project' => $project,
            'location' => $location,
            'app' => $app,
        ]);
    }

    /**
     * Formats a string containing the fully-qualified path to represent a generator
     * resource.
     *
     * @param string $project
     * @param string $location
     * @param string $generator
     *
     * @return string The formatted generator resource.
     */
    public static function generatorName(string $project, string $location, string $generator): string
    {
        return self::getPathTemplate('generator')->render([
            'project' => $project,
            'location' => $location,
            'generator' => $generator,
        ]);
    }

    /**
     * Formats a string containing the fully-qualified path to represent a
     * generator_evaluation resource.
     *
     * @param string $project
     * @param string $location
     * @param string $generator
     * @param string $evaluation
     *
     * @return string The formatted generator_evaluation resource.
     */
    public static function generatorEvaluationName(
        string $project,
        string $location,
        string $generator,
        string $evaluation
    ): string {
        return self::getPathTemplate('generatorEvaluation')->render([
            'project' => $project,
            'location' => $location,
            'generator' => $generator,
            'evaluation' => $evaluation,
        ]);
    }

    /**
     * Formats a string containing the fully-qualified path to represent a tool
     * resource.
     *
     * @param string $project
     * @param string $location
     * @param string $tool
     *
     * @return string The formatted tool resource.
     */
    public static function toolName(string $project, string $location, string $tool): string
    {
        return self::getPathTemplate('tool')->render([
            'project' => $project,
            'location' => $location,
            'tool' => $tool,
        ]);
    }

    /**
     * Formats a string containing the fully-qualified path to represent a toolset
     * resource.
     *
     * @param string $project
     * @param string $location
     * @param string $app
     * @param string $toolset
     *
     * @return string The formatted toolset resource.
     */
    public static function toolsetName(string $project, string $location, string $app, string $toolset): string
    {
        return self::getPathTemplate('toolset')->render([
            'project' => $project,
            'location' => $location,
            'app' => $app,
            'toolset' => $toolset,
        ]);
    }

    /**
     * Parses a formatted name string and returns an associative array of the components in the name.
     * The following name formats are supported:
     * Template: Pattern
     * - app: projects/{project}/locations/{location}/apps/{app}
     * - generator: projects/{project}/locations/{location}/generators/{generator}
     * - generatorEvaluation: projects/{project}/locations/{location}/generators/{generator}/evaluations/{evaluation}
     * - tool: projects/{project}/locations/{location}/tools/{tool}
     * - toolset: projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
     *
     * The optional $template argument can be supplied to specify a particular pattern,
     * and must match one of the templates listed above. If no $template argument is
     * provided, or if the $template argument does not match one of the templates
     * listed, then parseName will check each of the supported templates, and return
     * the first match.
     *
     * @param string  $formattedName The formatted name string
     * @param ?string $template      Optional name of template to match
     *
     * @return array An associative array from name component IDs to component values.
     *
     * @throws ValidationException If $formattedName could not be matched.
     */
    public static function parseName(string $formattedName, ?string $template = null): array
    {
        return self::parseFormattedName($formattedName, $template);
    }

    /**
     * Constructor.
     *
     * @param array|ClientOptions $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 'dialogflow.googleapis.com:443'.
     *     @type FetchAuthTokenInterface|CredentialsWrapper $credentials
     *           This option should only be used with a pre-constructed
     *           {@see FetchAuthTokenInterface} or {@see CredentialsWrapper} object. Note that
     *           when one of these objects are provided, any settings in $credentialsConfig will
     *           be ignored.
     *           **Important**: If you are providing a path to a credentials file, or a decoded
     *           credentials file as a PHP array, this usage is now DEPRECATED. Providing an
     *           unvalidated credential configuration to Google APIs can compromise the security
     *           of your systems and data. It is recommended to create the credentials explicitly
     *           ```
     *           use Google\Auth\Credentials\ServiceAccountCredentials;
     *           use Google\Cloud\Dialogflow\V2\GeneratorEvaluationsClient;
     *           $creds = new ServiceAccountCredentials($scopes, $json);
     *           $options = new GeneratorEvaluationsClient(['credentials' => $creds]);
     *           ```
     *           {@see
     *           https://cloud.google.com/docs/authentication/external/externally-sourced-credentials}
     *     @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.
     *     @type false|LoggerInterface $logger
     *           A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the
     *           'GOOGLE_SDK_PHP_LOGGING' environment flag
     *     @type string $universeDomain
     *           The service domain for the client. Defaults to 'googleapis.com'.
     * }
     *
     * @throws ValidationException
     */
    public function __construct(array|ClientOptions $options = [])
    {
        $clientOptions = $this->buildClientOptions($options);
        $this->setClientOptions($clientOptions);
        $this->operationsClient = $this->createOperationsClient($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);
    }

    /**
     * Creates evaluation of a generator.
     *
     * The async variant is
     * {@see GeneratorEvaluationsClient::createGeneratorEvaluationAsync()} .
     *
     * @example samples/V2/GeneratorEvaluationsClient/create_generator_evaluation.php
     *
     * @param CreateGeneratorEvaluationRequest $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 OperationResponse<GeneratorEvaluation>
     *
     * @throws ApiException Thrown if the API call fails.
     */
    public function createGeneratorEvaluation(
        CreateGeneratorEvaluationRequest $request,
        array $callOptions = []
    ): OperationResponse {
        return $this->startApiCall('CreateGeneratorEvaluation', $request, $callOptions)->wait();
    }

    /**
     * Deletes an evaluation of generator.
     *
     * The async variant is
     * {@see GeneratorEvaluationsClient::deleteGeneratorEvaluationAsync()} .
     *
     * @example samples/V2/GeneratorEvaluationsClient/delete_generator_evaluation.php
     *
     * @param DeleteGeneratorEvaluationRequest $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.
     * }
     *
     * @throws ApiException Thrown if the API call fails.
     */
    public function deleteGeneratorEvaluation(DeleteGeneratorEvaluationRequest $request, array $callOptions = []): void
    {
        $this->startApiCall('DeleteGeneratorEvaluation', $request, $callOptions)->wait();
    }

    /**
     * Gets an evaluation of generator.
     *
     * The async variant is
     * {@see GeneratorEvaluationsClient::getGeneratorEvaluationAsync()} .
     *
     * @example samples/V2/GeneratorEvaluationsClient/get_generator_evaluation.php
     *
     * @param GetGeneratorEvaluationRequest $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 GeneratorEvaluation
     *
     * @throws ApiException Thrown if the API call fails.
     */
    public function getGeneratorEvaluation(
        GetGeneratorEvaluationRequest $request,
        array $callOptions = []
    ): GeneratorEvaluation {
        return $this->startApiCall('GetGeneratorEvaluation', $request, $callOptions)->wait();
    }

    /**
     * Lists evaluations of generator.
     *
     * The async variant is
     * {@see GeneratorEvaluationsClient::listGeneratorEvaluationsAsync()} .
     *
     * @example samples/V2/GeneratorEvaluationsClient/list_generator_evaluations.php
     *
     * @param ListGeneratorEvaluationsRequest $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.
     */
    public function listGeneratorEvaluations(
        ListGeneratorEvaluationsRequest $request,
        array $callOptions = []
    ): PagedListResponse {
        return $this->startApiCall('ListGeneratorEvaluations', $request, $callOptions);
    }

    /**
     * Gets information about a location.
     *
     * The async variant is {@see GeneratorEvaluationsClient::getLocationAsync()} .
     *
     * @example samples/V2/GeneratorEvaluationsClient/get_location.php
     *
     * @param GetLocationRequest $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 Location
     *
     * @throws ApiException Thrown if the API call fails.
     */
    public function getLocation(GetLocationRequest $request, array $callOptions = []): Location
    {
        return $this->startApiCall('GetLocation', $request, $callOptions)->wait();
    }

    /**
     * Lists information about the supported locations for this service.

    This method lists locations based on the resource scope provided in
    the [ListLocationsRequest.name] field:

    * **Global locations**: If `name` is empty, the method lists the
    public locations available to all projects. * **Project-specific
    locations**: If `name` follows the format
    `projects/{project}`, the method lists locations visible to that
    specific project. This includes public, private, or other
    project-specific locations enabled for the project.

    For gRPC and client library implementations, the resource name is
    passed as the `name` field. For direct service calls, the resource
    name is
    incorporated into the request path based on the specific service
    implementation and version.
     *
     * The async variant is {@see GeneratorEvaluationsClient::listLocationsAsync()} .
     *
     * @example samples/V2/GeneratorEvaluationsClient/list_locations.php
     *
     * @param ListLocationsRequest $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.
     */
    public function listLocations(ListLocationsRequest $request, array $callOptions = []): PagedListResponse
    {
        return $this->startApiCall('ListLocations', $request, $callOptions);
    }
}
