<?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\Dataform\Resource;

use Google\Service\Dataform\Config;
use Google\Service\Dataform\ListLocationsResponse;
use Google\Service\Dataform\Location;
use Google\Service\Dataform\QueryUserRootContentsResponse;

/**
 * The "locations" collection of methods.
 * Typical usage is:
 *  <code>
 *   $dataformService = new Google\Service\Dataform(...);
 *   $locations = $dataformService->projects_locations;
 *  </code>
 */
class ProjectsLocations extends \Google\Service\Resource
{
  /**
   * Gets information about a location. (locations.get)
   *
   * @param string $name Resource name for the location.
   * @param array $optParams Optional parameters.
   * @return Location
   * @throws \Google\Service\Exception
   */
  public function get($name, $optParams = [])
  {
    $params = ['name' => $name];
    $params = array_merge($params, $optParams);
    return $this->call('get', [$params], Location::class);
  }
  /**
   * Get default config for a given project and location. (locations.getConfig)
   *
   * @param string $name Required. The config name.
   * @param array $optParams Optional parameters.
   * @return Config
   * @throws \Google\Service\Exception
   */
  public function getConfig($name, $optParams = [])
  {
    $params = ['name' => $name];
    $params = array_merge($params, $optParams);
    return $this->call('getConfig', [$params], Config::class);
  }
  /**
   * 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. (locations.listProjectsLocations)
   *
   * @param string $name The resource that owns the locations collection, if
   * applicable.
   * @param array $optParams Optional parameters.
   *
   * @opt_param string extraLocationTypes Optional. Do not use this field unless
   * explicitly documented otherwise. This is primarily for internal usage.
   * @opt_param string filter A filter to narrow down results to a preferred
   * subset. The filtering language accepts strings like `"displayName=tokyo"`,
   * and is documented in more detail in [AIP-160](https://google.aip.dev/160).
   * @opt_param int pageSize The maximum number of results to return. If not set,
   * the service selects a default.
   * @opt_param string pageToken A page token received from the `next_page_token`
   * field in the response. Send that page token to receive the subsequent page.
   * @return ListLocationsResponse
   * @throws \Google\Service\Exception
   */
  public function listProjectsLocations($name, $optParams = [])
  {
    $params = ['name' => $name];
    $params = array_merge($params, $optParams);
    return $this->call('list', [$params], ListLocationsResponse::class);
  }
  /**
   * Returns the contents of a caller's root folder in a given location. The root
   * folder contains all resources that are created by the user and not contained
   * in any other folder. (locations.queryUserRootContents)
   *
   * @param string $location Required. Location of the user root folder to list
   * contents for. Format: projects/locations
   * @param array $optParams Optional parameters.
   *
   * @opt_param string filter Optional. Optional filtering for the returned list.
   * Filtering is currently only supported on the `display_name` field. Example: *
   * `filter="display_name="MyFolder""`
   * @opt_param string orderBy Optional. Field to additionally sort results by.
   * Will order Folders before Repositories, and then by `order_by` in ascending
   * order. Supported keywords: display_name (default), created_at,
   * last_modified_at. Examples: * `orderBy="display_name"` *
   * `orderBy="display_name desc"`
   * @opt_param int pageSize Optional. Maximum number of paths to return. The
   * server may return fewer items than requested. If unspecified, the server will
   * pick an appropriate default.
   * @opt_param string pageToken Optional. Page token received from a previous
   * `QueryUserRootContents` call. Provide this to retrieve the subsequent page.
   * When paginating, all other parameters provided to
   * `QueryUserRootFolderContents`, with the exception of `page_size`, must match
   * the call that provided the page token.
   * @return QueryUserRootContentsResponse
   * @throws \Google\Service\Exception
   */
  public function queryUserRootContents($location, $optParams = [])
  {
    $params = ['location' => $location];
    $params = array_merge($params, $optParams);
    return $this->call('queryUserRootContents', [$params], QueryUserRootContentsResponse::class);
  }
  /**
   * Update default config for a given project and location. **Note:** *This
   * method does not fully implement [AIP/134](https://google.aip.dev/134). The
   * wildcard entry () is treated as a bad request, and when the `field_mask` is
   * omitted, the request is treated as a full update on all modifiable fields.*
   * (locations.updateConfig)
   *
   * @param string $name Identifier. The config name.
   * @param Config $postBody
   * @param array $optParams Optional parameters.
   *
   * @opt_param string updateMask Optional. Specifies the fields to be updated in
   * the config.
   * @return Config
   * @throws \Google\Service\Exception
   */
  public function updateConfig($name, Config $postBody, $optParams = [])
  {
    $params = ['name' => $name, 'postBody' => $postBody];
    $params = array_merge($params, $optParams);
    return $this->call('updateConfig', [$params], Config::class);
  }
}

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