1. class
  2. Google
  3. \
  4. Service
  5. \
  6. CloudDataplex
  7. \
  8. Resource
  9. \
  10. ProjectsLocationsLakesTasks

ProjectsLocationsLakesTasks

class ProjectsLocationsLakesTasks extends Resource (View source)

The "tasks" collection of methods.

Typical usage is:

 $dataplexService = new Google\Service\CloudDataplex(...);
 $tasks = $dataplexService->projects_locations_lakes_tasks;

Methods

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

Creates a task resource within a lake. (tasks.create)

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

Delete the task resource. (tasks.delete)

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

Get task resource. (tasks.get)

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. (tasks.getIamPolicy)

GoogleCloudDataplexV1ListTasksResponse
listProjectsLocationsLakesTasks(string $parent, array $optParams = [])

Lists tasks under the given lake. (tasks.listProjectsLocationsLakesTasks)

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

Update the task resource. (tasks.patch)

GoogleCloudDataplexV1RunTaskResponse
run(string $name, GoogleCloudDataplexV1RunTaskRequest $postBody, array $optParams = [])

Run an on demand execution of a Task. (tasks.run)

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. (tasks.setIamPolicy)

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.

Details

at line 54
GoogleLongrunningOperation create(string $parent, GoogleCloudDataplexV1Task $postBody, array $optParams = [])

Creates a task resource within a lake. (tasks.create)

Parameters

string $parent

Required. The resource name of the parent lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}.
GoogleCloudDataplexV1Task $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

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

Delete the task resource. (tasks.delete)

Parameters

string $name

Required. The resource name of the task: projects/{projec t_number}/locations/{location_id}/lakes/{lake_id}/task/{task_id}.
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

at line 84
GoogleCloudDataplexV1Task get(string $name, array $optParams = [])

Get task resource. (tasks.get)

Parameters

string $name

Required. The resource name of the task: projects/{projec t_number}/locations/{location_id}/lakes/{lake_id}/tasks/{tasks_id}.
array $optParams

Optional parameters.

Return Value

GoogleCloudDataplexV1Task

Exceptions

Exception

at line 114
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. (tasks.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

at line 140
GoogleCloudDataplexV1ListTasksResponse listProjectsLocationsLakesTasks(string $parent, array $optParams = [])

Lists tasks under the given lake. (tasks.listProjectsLocationsLakesTasks)

Parameters

string $parent

Required. The resource name of the parent lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}.
array $optParams

Optional parameters.

Return Value

GoogleCloudDataplexV1ListTasksResponse

Exceptions

Exception

at line 161
GoogleLongrunningOperation patch(string $name, GoogleCloudDataplexV1Task $postBody, array $optParams = [])

Update the task resource. (tasks.patch)

Parameters

string $name

Output only. The relative resource name of the task, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/ tasks/{task_id}.
GoogleCloudDataplexV1Task $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

at line 177
GoogleCloudDataplexV1RunTaskResponse run(string $name, GoogleCloudDataplexV1RunTaskRequest $postBody, array $optParams = [])

Run an on demand execution of a Task. (tasks.run)

Parameters

string $name

Required. The resource name of the task: projects/{projec t_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}.
GoogleCloudDataplexV1RunTaskRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudDataplexV1RunTaskResponse

Exceptions

Exception

at line 197
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. (tasks.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

at line 219
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. (tasks.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