📄 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\ArtifactRegistry\Resource;
use Google\Service\ArtifactRegistry\ListLocationsResponse;
use Google\Service\ArtifactRegistry\Location;
use Google\Service\ArtifactRegistry\ProjectConfig;
use Google\Service\ArtifactRegistry\VPCSCConfig;
/**
* The "locations" collection of methods.
* Typical usage is:
* <code>
* $artifactregistryService = new Google\Service\ArtifactRegistry(...);
* $locations = $artifactregistryService->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);
}
/**
* Retrieves the project configuration. (locations.getProjectConfig)
*
* @param string $name Required. The name of the project's logging
* configuration: projects/{project}/locations/{location}/projectConfig
* @param array $optParams Optional parameters.
* @return ProjectConfig
* @throws \Google\Service\Exception
*/
public function getProjectConfig($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('getProjectConfig', [$params], ProjectConfig::class);
}
/**
* Retrieves the VPCSC Config for the Project. (locations.getVpcscConfig)
*
* @param string $name Required. The name of the VPCSCConfig resource.
* @param array $optParams Optional parameters.
* @return VPCSCConfig
* @throws \Google\Service\Exception
*/
public function getVpcscConfig($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('getVpcscConfig', [$params], VPCSCConfig::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. 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);
}
/**
* Updates the project configuration. (locations.updateProjectConfig)
*
* @param string $name Identifier. The name of the project's configuration.
* Always of the form: projects/{project}/locations/{location}/projectConfig
* @param ProjectConfig $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string updateMask Optional. Field mask to support partial updates.
* See https://protobuf.dev/reference/protobuf/google.protobuf/#field-mask for
* more details.
* @return ProjectConfig
* @throws \Google\Service\Exception
*/
public function updateProjectConfig($name, ProjectConfig $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('updateProjectConfig', [$params], ProjectConfig::class);
}
/**
* Updates the VPCSC Config for the Project. (locations.updateVpcscConfig)
*
* @param string $name The name of the project's VPC SC Config. Always of the
* form: projects/{projectID}/locations/{location}/vpcscConfig In update
* request: never set In response: always set
* @param VPCSCConfig $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string updateMask Field mask to support partial updates.
* @return VPCSCConfig
* @throws \Google\Service\Exception
*/
public function updateVpcscConfig($name, VPCSCConfig $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('updateVpcscConfig', [$params], VPCSCConfig::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ProjectsLocations::class, 'Google_Service_ArtifactRegistry_Resource_ProjectsLocations');
← Back