Google Cloud Dataplex V1 Client - Class GetEntityRequest (0.12.0)

Version 0.12.0

• 1.1.0 (latest)
• 1.0.1
• 0.16.1
• 0.15.1
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.1
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.1
• 0.4.0
• 0.3.0
• 0.2.3
• 0.1.6

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