Google Cloud Dataplex V1 Client - Class GetEntityRequest (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

Methods

__construct

Constructor.

Parameters
NameDescription
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}.

Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

Returns
TypeDescription
string

setName

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

Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getView

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

Defaults to BASIC.

Generated from protobuf field .google.cloud.dataplex.v1.GetEntityRequest.EntityView view = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
int

setView

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

Defaults to BASIC.

Generated from protobuf field .google.cloud.dataplex.v1.GetEntityRequest.EntityView view = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
var int
Returns
TypeDescription
$this