219 lines
9.8 KiB
PHP
219 lines
9.8 KiB
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\CloudDataplex\Resource;
|
|
|
|
use Google\Service\CloudDataplex\GoogleCloudDataplexV1Environment;
|
|
use Google\Service\CloudDataplex\GoogleCloudDataplexV1ListEnvironmentsResponse;
|
|
use Google\Service\CloudDataplex\GoogleIamV1Policy;
|
|
use Google\Service\CloudDataplex\GoogleIamV1SetIamPolicyRequest;
|
|
use Google\Service\CloudDataplex\GoogleIamV1TestIamPermissionsRequest;
|
|
use Google\Service\CloudDataplex\GoogleIamV1TestIamPermissionsResponse;
|
|
use Google\Service\CloudDataplex\GoogleLongrunningOperation;
|
|
|
|
/**
|
|
* The "environments" collection of methods.
|
|
* Typical usage is:
|
|
* <code>
|
|
* $dataplexService = new Google\Service\CloudDataplex(...);
|
|
* $environments = $dataplexService->projects_locations_lakes_environments;
|
|
* </code>
|
|
*/
|
|
class ProjectsLocationsLakesEnvironments extends \Google\Service\Resource
|
|
{
|
|
/**
|
|
* Create an environment resource. (environments.create)
|
|
*
|
|
* @param string $parent Required. The resource name of the parent lake:
|
|
* projects/{project_id}/locations/{location_id}/lakes/{lake_id}.
|
|
* @param GoogleCloudDataplexV1Environment $postBody
|
|
* @param array $optParams Optional parameters.
|
|
*
|
|
* @opt_param string environmentId Required. Environment identifier. * Must
|
|
* contain only lowercase letters, numbers and hyphens. * Must start with a
|
|
* letter. * Must be between 1-63 characters. * Must end with a number or a
|
|
* letter. * Must be unique within the lake.
|
|
* @opt_param bool validateOnly Optional. Only validate the request, but do not
|
|
* perform mutations. The default is false.
|
|
* @return GoogleLongrunningOperation
|
|
* @throws \Google\Service\Exception
|
|
*/
|
|
public function create($parent, GoogleCloudDataplexV1Environment $postBody, $optParams = [])
|
|
{
|
|
$params = ['parent' => $parent, 'postBody' => $postBody];
|
|
$params = array_merge($params, $optParams);
|
|
return $this->call('create', [$params], GoogleLongrunningOperation::class);
|
|
}
|
|
/**
|
|
* Delete the environment resource. All the child resources must have been
|
|
* deleted before environment deletion can be initiated. (environments.delete)
|
|
*
|
|
* @param string $name Required. The resource name of the environment: projects/
|
|
* {project_id}/locations/{location_id}/lakes/{lake_id}/environments/{environmen
|
|
* t_id}.
|
|
* @param array $optParams Optional parameters.
|
|
* @return GoogleLongrunningOperation
|
|
* @throws \Google\Service\Exception
|
|
*/
|
|
public function delete($name, $optParams = [])
|
|
{
|
|
$params = ['name' => $name];
|
|
$params = array_merge($params, $optParams);
|
|
return $this->call('delete', [$params], GoogleLongrunningOperation::class);
|
|
}
|
|
/**
|
|
* Get environment resource. (environments.get)
|
|
*
|
|
* @param string $name Required. The resource name of the environment: projects/
|
|
* {project_id}/locations/{location_id}/lakes/{lake_id}/environments/{environmen
|
|
* t_id}.
|
|
* @param array $optParams Optional parameters.
|
|
* @return GoogleCloudDataplexV1Environment
|
|
* @throws \Google\Service\Exception
|
|
*/
|
|
public function get($name, $optParams = [])
|
|
{
|
|
$params = ['name' => $name];
|
|
$params = array_merge($params, $optParams);
|
|
return $this->call('get', [$params], GoogleCloudDataplexV1Environment::class);
|
|
}
|
|
/**
|
|
* Gets the access control policy for a resource. Returns an empty policy if the
|
|
* resource exists and does not have a policy set. (environments.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 GoogleIamV1Policy
|
|
* @throws \Google\Service\Exception
|
|
*/
|
|
public function getIamPolicy($resource, $optParams = [])
|
|
{
|
|
$params = ['resource' => $resource];
|
|
$params = array_merge($params, $optParams);
|
|
return $this->call('getIamPolicy', [$params], GoogleIamV1Policy::class);
|
|
}
|
|
/**
|
|
* Lists environments under the given lake.
|
|
* (environments.listProjectsLocationsLakesEnvironments)
|
|
*
|
|
* @param string $parent Required. The resource name of the parent lake:
|
|
* projects/{project_id}/locations/{location_id}/lakes/{lake_id}.
|
|
* @param array $optParams Optional parameters.
|
|
*
|
|
* @opt_param string filter Optional. Filter request.
|
|
* @opt_param string orderBy Optional. Order by fields for the result.
|
|
* @opt_param int pageSize Optional. Maximum number of environments to return.
|
|
* The service may return fewer than this value. If unspecified, at most 10
|
|
* environments will be returned. The maximum value is 1000; values above 1000
|
|
* will be coerced to 1000.
|
|
* @opt_param string pageToken Optional. Page token received from a previous
|
|
* ListEnvironments call. Provide this to retrieve the subsequent page. When
|
|
* paginating, all other parameters provided to ListEnvironments must match the
|
|
* call that provided the page token.
|
|
* @return GoogleCloudDataplexV1ListEnvironmentsResponse
|
|
* @throws \Google\Service\Exception
|
|
*/
|
|
public function listProjectsLocationsLakesEnvironments($parent, $optParams = [])
|
|
{
|
|
$params = ['parent' => $parent];
|
|
$params = array_merge($params, $optParams);
|
|
return $this->call('list', [$params], GoogleCloudDataplexV1ListEnvironmentsResponse::class);
|
|
}
|
|
/**
|
|
* Update the environment resource. (environments.patch)
|
|
*
|
|
* @param string $name Output only. The relative resource name of the
|
|
* environment, of the form: projects/{project_id}/locations/{location_id}/lakes
|
|
* /{lake_id}/environment/{environment_id}
|
|
* @param GoogleCloudDataplexV1Environment $postBody
|
|
* @param array $optParams Optional parameters.
|
|
*
|
|
* @opt_param string updateMask Required. Mask of fields to update.
|
|
* @opt_param bool validateOnly Optional. Only validate the request, but do not
|
|
* perform mutations. The default is false.
|
|
* @return GoogleLongrunningOperation
|
|
* @throws \Google\Service\Exception
|
|
*/
|
|
public function patch($name, GoogleCloudDataplexV1Environment $postBody, $optParams = [])
|
|
{
|
|
$params = ['name' => $name, 'postBody' => $postBody];
|
|
$params = array_merge($params, $optParams);
|
|
return $this->call('patch', [$params], GoogleLongrunningOperation::class);
|
|
}
|
|
/**
|
|
* Sets the access control policy on the specified resource. Replaces any
|
|
* existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED
|
|
* errors. (environments.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 GoogleIamV1SetIamPolicyRequest $postBody
|
|
* @param array $optParams Optional parameters.
|
|
* @return GoogleIamV1Policy
|
|
* @throws \Google\Service\Exception
|
|
*/
|
|
public function setIamPolicy($resource, GoogleIamV1SetIamPolicyRequest $postBody, $optParams = [])
|
|
{
|
|
$params = ['resource' => $resource, 'postBody' => $postBody];
|
|
$params = array_merge($params, $optParams);
|
|
return $this->call('setIamPolicy', [$params], GoogleIamV1Policy::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.
|
|
* (environments.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 GoogleIamV1TestIamPermissionsRequest $postBody
|
|
* @param array $optParams Optional parameters.
|
|
* @return GoogleIamV1TestIamPermissionsResponse
|
|
* @throws \Google\Service\Exception
|
|
*/
|
|
public function testIamPermissions($resource, GoogleIamV1TestIamPermissionsRequest $postBody, $optParams = [])
|
|
{
|
|
$params = ['resource' => $resource, 'postBody' => $postBody];
|
|
$params = array_merge($params, $optParams);
|
|
return $this->call('testIamPermissions', [$params], GoogleIamV1TestIamPermissionsResponse::class);
|
|
}
|
|
}
|
|
|
|
// Adding a class alias for backwards compatibility with the previous class name.
|
|
class_alias(ProjectsLocationsLakesEnvironments::class, 'Google_Service_CloudDataplex_Resource_ProjectsLocationsLakesEnvironments');
|