📂 File Browser

📁 Directories

📄 Files

📄 Source: ProjectsLocationsAgents.php

<?php
/*
 * Copyright 2014 Google Inc.
 *
 * 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
 *
 * http://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.
 */

namespace Google\Service\AgentRegistry\Resource;

use Google\Service\AgentRegistry\Agent;
use Google\Service\AgentRegistry\ListAgentsResponse;
use Google\Service\AgentRegistry\SearchAgentsRequest;
use Google\Service\AgentRegistry\SearchAgentsResponse;

/**
 * The "agents" collection of methods.
 * Typical usage is:
 *  <code>
 *   $agentregistryService = new Google\Service\AgentRegistry(...);
 *   $agents = $agentregistryService->projects_locations_agents;
 *  </code>
 */
class ProjectsLocationsAgents extends \Google\Service\Resource
{
  /**
   * Gets details of a single Agent. (agents.get)
   *
   * @param string $name Required. Name of the resource
   * @param array $optParams Optional parameters.
   * @return Agent
   * @throws \Google\Service\Exception
   */
  public function get($name, $optParams = [])
  {
    $params = ['name' => $name];
    $params = array_merge($params, $optParams);
    return $this->call('get', [$params], Agent::class);
  }
  /**
   * Lists Agents in a given project and location.
   * (agents.listProjectsLocationsAgents)
   *
   * @param string $parent Required. Parent value for ListAgentsRequest
   * @param array $optParams Optional parameters.
   *
   * @opt_param string filter Optional. Filtering results
   * @opt_param string orderBy Optional. Hint for how to order the results
   * @opt_param int pageSize Optional. Requested page size. Server may return
   * fewer items than requested. If unspecified, server will pick an appropriate
   * default.
   * @opt_param string pageToken Optional. A token identifying a page of results
   * the server should return.
   * @return ListAgentsResponse
   * @throws \Google\Service\Exception
   */
  public function listProjectsLocationsAgents($parent, $optParams = [])
  {
    $params = ['parent' => $parent];
    $params = array_merge($params, $optParams);
    return $this->call('list', [$params], ListAgentsResponse::class);
  }
  /**
   * Searches Agents in a given project and location. (agents.search)
   *
   * @param string $parent Required. Parent value for SearchAgentsRequest. Format:
   * `projects/{project}/locations/{location}`.
   * @param SearchAgentsRequest $postBody
   * @param array $optParams Optional parameters.
   * @return SearchAgentsResponse
   * @throws \Google\Service\Exception
   */
  public function search($parent, SearchAgentsRequest $postBody, $optParams = [])
  {
    $params = ['parent' => $parent, 'postBody' => $postBody];
    $params = array_merge($params, $optParams);
    return $this->call('search', [$params], SearchAgentsResponse::class);
  }
}

// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ProjectsLocationsAgents::class, 'Google_Service_AgentRegistry_Resource_ProjectsLocationsAgents');