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

ProjectsLocationsLakesZonesEntities

class ProjectsLocationsLakesZonesEntities extends Resource (View source)

The "entities" collection of methods.

Typical usage is:

 $dataplexService = new Google\Service\CloudDataplex(...);
 $entities = $dataplexService->projects_locations_lakes_zones_entities;

Methods

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

Create a metadata entity. (entities.create)

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

Delete a metadata entity. (entities.delete)

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

Get a metadata entity. (entities.get)

GoogleCloudDataplexV1ListEntitiesResponse
listProjectsLocationsLakesZonesEntities(string $parent, array $optParams = [])

List metadata entities in a zone.

GoogleCloudDataplexV1Entity
update(string $name, GoogleCloudDataplexV1Entity $postBody, array $optParams = [])

Update a metadata entity. Only supports full resource update.

Details

at line 47
GoogleCloudDataplexV1Entity create(string $parent, GoogleCloudDataplexV1Entity $postBody, array $optParams = [])

Create a metadata entity. (entities.create)

Parameters

string $parent

Required. The resource name of the parent zone: project s/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}.
GoogleCloudDataplexV1Entity $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudDataplexV1Entity

Exceptions

Exception

at line 66
DataplexEmpty delete(string $name, array $optParams = [])

Delete a metadata entity. (entities.delete)

Parameters

string $name

Required. The resource name of the entity: projects/{proj ect_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/ {entity_id}.
array $optParams

Optional parameters.

Return Value

DataplexEmpty

Exceptions

Exception

at line 85
GoogleCloudDataplexV1Entity get(string $name, array $optParams = [])

Get a metadata entity. (entities.get)

Parameters

string $name

Required. The resource name of the entity: projects/{proj ect_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/ {entity_id}.
array $optParams

Optional parameters.

Return Value

GoogleCloudDataplexV1Entity

Exceptions

Exception

at line 118
GoogleCloudDataplexV1ListEntitiesResponse listProjectsLocationsLakesZonesEntities(string $parent, array $optParams = [])

List metadata entities in a zone.

(entities.listProjectsLocationsLakesZonesEntities)

Parameters

string $parent

Required. The resource name of the parent zone: project s/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}.
array $optParams

Optional parameters.

Return Value

GoogleCloudDataplexV1ListEntitiesResponse

Exceptions

Exception

at line 139
GoogleCloudDataplexV1Entity update(string $name, GoogleCloudDataplexV1Entity $postBody, array $optParams = [])

Update a metadata entity. Only supports full resource update.

(entities.update)

Parameters

string $name

Output only. The resource name of the entity, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones /{zone_id}/entities/{id}.
GoogleCloudDataplexV1Entity $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudDataplexV1Entity

Exceptions

Exception