class ProjectsLocationsLakesEnvironments extends Resource (View source)

The "environments" collection of methods.

Typical usage is:

 $dataplexService = new Google\Service\CloudDataplex(...);
 $environments = $dataplexService->projects_locations_lakes_environments;

Methods

create(string $parent, GoogleCloudDataplexV1Environment $postBody, array $optParams = [])

Create an environment resource. (environments.create)

delete(string $name, array $optParams = [])

Delete the environment resource. All the child resources must have been deleted before environment deletion can be initiated. (environments.delete)

get(string $name, array $optParams = [])

Get environment resource. (environments.get)

getIamPolicy(string $resource, array $optParams = [])

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)

listProjectsLocationsLakesEnvironments(string $parent, array $optParams = [])

Lists environments under the given lake.

patch(string $name, GoogleCloudDataplexV1Environment $postBody, array $optParams = [])

Update the environment resource. (environments.patch)

setIamPolicy(string $resource, GoogleIamV1SetIamPolicyRequest $postBody, array $optParams = [])

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)

testIamPermissions(string $resource, GoogleIamV1TestIamPermissionsRequest $postBody, array $optParams = [])

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.

Details

GoogleLongrunningOperation create(string $parent, GoogleCloudDataplexV1Environment $postBody, array $optParams = [])

Create an environment resource. (environments.create)

Parameters

string $parent

Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id}.

GoogleCloudDataplexV1Environment $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

GoogleLongrunningOperation delete(string $name, array $optParams = [])

Delete the environment resource. All the child resources must have been deleted before environment deletion can be initiated. (environments.delete)

Parameters

string $name

Required. The resource name of the environment: projects/ {project_id}/locations/{location_id}/lakes/{lake_id}/environments/{environmen t_id}.

array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

GoogleCloudDataplexV1Environment get(string $name, array $optParams = [])

Get environment resource. (environments.get)

Parameters

string $name

Required. The resource name of the environment: projects/ {project_id}/locations/{location_id}/lakes/{lake_id}/environments/{environmen t_id}.

array $optParams

Optional parameters.

Return Value

GoogleCloudDataplexV1Environment

Exceptions

Exception

GoogleIamV1Policy getIamPolicy(string $resource, array $optParams = [])

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)

Parameters

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.

array $optParams

Optional parameters.

Return Value

GoogleIamV1Policy

Exceptions

Exception

GoogleCloudDataplexV1ListEnvironmentsResponse listProjectsLocationsLakesEnvironments(string $parent, array $optParams = [])

Lists environments under the given lake.

(environments.listProjectsLocationsLakesEnvironments)

Parameters

string $parent

Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id}.

array $optParams

Optional parameters.

Return Value

GoogleCloudDataplexV1ListEnvironmentsResponse

Exceptions

Exception

GoogleLongrunningOperation patch(string $name, GoogleCloudDataplexV1Environment $postBody, array $optParams = [])

Update the environment resource. (environments.patch)

Parameters

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}

GoogleCloudDataplexV1Environment $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

GoogleIamV1Policy setIamPolicy(string $resource, GoogleIamV1SetIamPolicyRequest $postBody, array $optParams = [])

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)

Parameters

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.

GoogleIamV1SetIamPolicyRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleIamV1Policy

Exceptions

Exception

GoogleIamV1TestIamPermissionsResponse testIamPermissions(string $resource, GoogleIamV1TestIamPermissionsRequest $postBody, array $optParams = [])

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)

Parameters

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.

GoogleIamV1TestIamPermissionsRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleIamV1TestIamPermissionsResponse

Exceptions

Exception