Google Cloud Dataplex V1 Client - Class GetEntityRequest (0.15.1)

Reference documentation and code samples for the Google Cloud Dataplex V1 Client class GetEntityRequest.

Get metadata entity request.

Generated from protobuf message google.cloud.dataplex.v1.GetEntityRequest

Namespace

Google \ Cloud \ Dataplex \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

Required. The resource name of the entity: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}.
↳ view int

Optional. Used to select the subset of entity information to return. Defaults to BASIC.

getName

Required. The resource name of the entity: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}.

Returns
Type Description
string

setName

Required. The resource name of the entity: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}.

Parameter
Name Description
var string
Returns
Type Description
$this

getView

Optional. Used to select the subset of entity information to return.

Defaults to BASIC.

Returns
Type Description
int

setView

Optional. Used to select the subset of entity information to return.

Defaults to BASIC.

Parameter
Name Description
var int
Returns
Type Description
$this

static::build

Parameter
Name Description
name string

Required. The resource name of the entity: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}. Please see Google\Cloud\Dataplex\V1\MetadataServiceClient::entityName() for help formatting this field.
Returns
Type Description
Google\Cloud\Dataplex\V1\GetEntityRequest