📄 Source: ProjectsLocationsManagementServers.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\Backupdr\Resource;
use Google\Service\Backupdr\FetchMsComplianceMetadataRequest;
use Google\Service\Backupdr\FetchMsComplianceMetadataResponse;
use Google\Service\Backupdr\ListManagementServersResponse;
use Google\Service\Backupdr\ManagementServer;
use Google\Service\Backupdr\Operation;
use Google\Service\Backupdr\Policy;
use Google\Service\Backupdr\SetIamPolicyRequest;
use Google\Service\Backupdr\TestIamPermissionsRequest;
use Google\Service\Backupdr\TestIamPermissionsResponse;
/**
* The "managementServers" collection of methods.
* Typical usage is:
* <code>
* $backupdrService = new Google\Service\Backupdr(...);
* $managementServers = $backupdrService->projects_locations_managementServers;
* </code>
*/
class ProjectsLocationsManagementServers extends \Google\Service\Resource
{
/**
* Creates a new ManagementServer in a given project and location.
* (managementServers.create)
*
* @param string $parent Required. The management server project and location in
* the format 'projects/{project_id}/locations/{location}'. In Cloud Backup and
* DR locations map to Google Cloud regions, for example **us-central1**.
* @param ManagementServer $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string managementServerId Required. The name of the management
* server to create. The name must be unique for the specified project and
* location.
* @opt_param string requestId Optional. An optional request ID to identify
* requests. Specify a unique request ID so that if you must retry your request,
* the server will know to ignore the request if it has already been completed.
* The server will guarantee that for at least 60 minutes since the first
* request. For example, consider a situation where you make an initial request
* and the request times out. If you make the request again with the same
* request ID, the server can check if original operation with the same request
* ID was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments. The request ID must
* be a valid UUID with the exception that zero UUID is not supported
* (00000000-0000-0000-0000-000000000000).
* @return Operation
* @throws \Google\Service\Exception
*/
public function create($parent, ManagementServer $postBody, $optParams = [])
{
$params = ['parent' => $parent, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('create', [$params], Operation::class);
}
/**
* Deletes a single ManagementServer. (managementServers.delete)
*
* @param string $name Required. Name of the resource
* @param array $optParams Optional parameters.
*
* @opt_param string requestId Optional. An optional request ID to identify
* requests. Specify a unique request ID so that if you must retry your request,
* the server will know to ignore the request if it has already been completed.
* The server will guarantee that for at least 60 minutes after the first
* request. For example, consider a situation where you make an initial request
* and the request times out. If you make the request again with the same
* request ID, the server can check if original operation with the same request
* ID was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments. The request ID must
* be a valid UUID with the exception that zero UUID is not supported
* (00000000-0000-0000-0000-000000000000).
* @return Operation
* @throws \Google\Service\Exception
*/
public function delete($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('delete', [$params], Operation::class);
}
/**
* Gets details of a single ManagementServer. (managementServers.get)
*
* @param string $name Required. Name of the management server resource name, in
* the format 'projects/{project_id}/locations/{location}/managementServers/{res
* ource_name}'
* @param array $optParams Optional parameters.
* @return ManagementServer
* @throws \Google\Service\Exception
*/
public function get($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], ManagementServer::class);
}
/**
* Gets the access control policy for a resource. Returns an empty policy if the
* resource exists and does not have a policy set.
* (managementServers.getIamPolicy)
*
* @param string $resource REQUIRED: The resource for which the policy is being
* requested. See [Resource
* names](https://cloud.google.com/apis/design/resource_names) for the
* appropriate value for this field.
* @param array $optParams Optional parameters.
*
* @opt_param int options.requestedPolicyVersion Optional. The maximum policy
* version that will be used to format the policy. Valid values are 0, 1, and 3.
* Requests specifying an invalid value will be rejected. Requests for policies
* with any conditional role bindings must specify version 3. Policies with no
* conditional role bindings may specify any valid value or leave the field
* unset. The policy in the response might use the policy version that you
* specified, or it might use a lower policy version. For example, if you
* specify version 3, but the policy has no conditional role bindings, the
* response uses version 1. To learn which resources support conditions in their
* IAM policies, see the [IAM
* documentation](https://cloud.google.com/iam/help/conditions/resource-
* policies).
* @return Policy
* @throws \Google\Service\Exception
*/
public function getIamPolicy($resource, $optParams = [])
{
$params = ['resource' => $resource];
$params = array_merge($params, $optParams);
return $this->call('getIamPolicy', [$params], Policy::class);
}
/**
* Lists ManagementServers in a given project and location.
* (managementServers.listProjectsLocationsManagementServers)
*
* @param string $parent Required. The project and location for which to
* retrieve management servers information, in the format
* 'projects/{project_id}/locations/{location}'. In Google Cloud Backup and DR,
* locations map to Google Cloud regions, for example **us-central1**. To
* retrieve management servers for all locations, use "-" for the '{location}'
* value.
* @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 ListManagementServersResponse
* @throws \Google\Service\Exception
*/
public function listProjectsLocationsManagementServers($parent, $optParams = [])
{
$params = ['parent' => $parent];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListManagementServersResponse::class);
}
/**
* Returns the Assured Workloads compliance metadata for a given project.
* (managementServers.msComplianceMetadata)
*
* @param string $parent Required. The project and location to be used to check
* CSS metadata for target project information, in the format
* 'projects/{project_id}/locations/{location}'. In Google Cloud Backup and DR,
* locations map to Google Cloud regions, for example **us-central1**.
* @param FetchMsComplianceMetadataRequest $postBody
* @param array $optParams Optional parameters.
* @return FetchMsComplianceMetadataResponse
* @throws \Google\Service\Exception
*/
public function msComplianceMetadata($parent, FetchMsComplianceMetadataRequest $postBody, $optParams = [])
{
$params = ['parent' => $parent, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('msComplianceMetadata', [$params], FetchMsComplianceMetadataResponse::class);
}
/**
* Sets the access control policy on the specified resource. Replaces any
* existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and
* `PERMISSION_DENIED` errors. (managementServers.setIamPolicy)
*
* @param string $resource REQUIRED: The resource for which the policy is being
* specified. See [Resource
* names](https://cloud.google.com/apis/design/resource_names) for the
* appropriate value for this field.
* @param SetIamPolicyRequest $postBody
* @param array $optParams Optional parameters.
* @return Policy
* @throws \Google\Service\Exception
*/
public function setIamPolicy($resource, SetIamPolicyRequest $postBody, $optParams = [])
{
$params = ['resource' => $resource, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('setIamPolicy', [$params], Policy::class);
}
/**
* Returns permissions that a caller has on the specified resource. If the
* resource does not exist, this will return an empty set of permissions, not a
* `NOT_FOUND` error. Note: This operation is designed to be used for building
* permission-aware UIs and command-line tools, not for authorization checking.
* This operation may "fail open" without warning.
* (managementServers.testIamPermissions)
*
* @param string $resource REQUIRED: The resource for which the policy detail is
* being requested. See [Resource
* names](https://cloud.google.com/apis/design/resource_names) for the
* appropriate value for this field.
* @param TestIamPermissionsRequest $postBody
* @param array $optParams Optional parameters.
* @return TestIamPermissionsResponse
* @throws \Google\Service\Exception
*/
public function testIamPermissions($resource, TestIamPermissionsRequest $postBody, $optParams = [])
{
$params = ['resource' => $resource, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('testIamPermissions', [$params], TestIamPermissionsResponse::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ProjectsLocationsManagementServers::class, 'Google_Service_Backupdr_Resource_ProjectsLocationsManagementServers');
← Back