📂 File Browser

📁 Directories

📄 Files

📄 Source: ProjectsLocations.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\CloudScheduler\Resource;

use Google\Service\CloudScheduler\CmekConfig;
use Google\Service\CloudScheduler\ListLocationsResponse;
use Google\Service\CloudScheduler\Location;
use Google\Service\CloudScheduler\Operation;

/**
 * The "locations" collection of methods.
 * Typical usage is:
 *  <code>
 *   $cloudschedulerService = new Google\Service\CloudScheduler(...);
 *   $locations = $cloudschedulerService->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);
  }
  /**
   * Gets the Scheduler config in the project/region. (locations.getCmekConfig)
   *
   * @param string $name Required. The config name. For example:
   * projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig
   * @param array $optParams Optional parameters.
   * @return CmekConfig
   * @throws \Google\Service\Exception
   */
  public function getCmekConfig($name, $optParams = [])
  {
    $params = ['name' => $name];
    $params = array_merge($params, $optParams);
    return $this->call('getCmekConfig', [$params], CmekConfig::class);
  }
  /**
   * Lists information about the supported locations for this service. This method
   * can be called in two ways: * **List all public locations:** Use the path `GET
   * /v1/locations`. * **List project-visible locations:** Use the path `GET
   * /v1/projects/{project_id}/locations`. This may include public locations as
   * well as private or other locations specifically visible to the project.
   * (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. It is
   * unsupported and is ignored 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);
  }
  /**
   * Initializes or Updates the a scheduler config. (locations.updateCmekConfig)
   *
   * @param string $name Identifier. The config resource name which includes the
   * project and location and must end in 'cmekConfig', in the format
   * projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig`
   * @param CmekConfig $postBody
   * @param array $optParams Optional parameters.
   *
   * @opt_param string updateMask Optional. List of fields to be updated in this
   * request.
   * @return Operation
   * @throws \Google\Service\Exception
   */
  public function updateCmekConfig($name, CmekConfig $postBody, $optParams = [])
  {
    $params = ['name' => $name, 'postBody' => $postBody];
    $params = array_merge($params, $optParams);
    return $this->call('updateCmekConfig', [$params], Operation::class);
  }
}

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