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
Enum of type EntityView.
setView
Optional. Used to select the subset of entity information to return.
Defaults to BASIC.
Parameter
Name
Description
var
int
Enum of type EntityView.
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 MetadataServiceClient::entityName() for help formatting this field.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# Google Cloud Dataplex V1 Client - Class GetEntityRequest (1.7.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.7.1 (latest)](/php/docs/reference/cloud-dataplex/latest/V1.GetEntityRequest)\n- [1.7.0](/php/docs/reference/cloud-dataplex/1.7.0/V1.GetEntityRequest)\n- [1.6.1](/php/docs/reference/cloud-dataplex/1.6.1/V1.GetEntityRequest)\n- [1.4.0](/php/docs/reference/cloud-dataplex/1.4.0/V1.GetEntityRequest)\n- [1.3.0](/php/docs/reference/cloud-dataplex/1.3.0/V1.GetEntityRequest)\n- [1.2.1](/php/docs/reference/cloud-dataplex/1.2.1/V1.GetEntityRequest)\n- [1.1.1](/php/docs/reference/cloud-dataplex/1.1.1/V1.GetEntityRequest)\n- [1.0.1](/php/docs/reference/cloud-dataplex/1.0.1/V1.GetEntityRequest)\n- [0.16.1](/php/docs/reference/cloud-dataplex/0.16.1/V1.GetEntityRequest)\n- [0.15.1](/php/docs/reference/cloud-dataplex/0.15.1/V1.GetEntityRequest)\n- [0.14.0](/php/docs/reference/cloud-dataplex/0.14.0/V1.GetEntityRequest)\n- [0.13.0](/php/docs/reference/cloud-dataplex/0.13.0/V1.GetEntityRequest)\n- [0.12.0](/php/docs/reference/cloud-dataplex/0.12.0/V1.GetEntityRequest)\n- [0.11.1](/php/docs/reference/cloud-dataplex/0.11.1/V1.GetEntityRequest)\n- [0.10.0](/php/docs/reference/cloud-dataplex/0.10.0/V1.GetEntityRequest)\n- [0.9.0](/php/docs/reference/cloud-dataplex/0.9.0/V1.GetEntityRequest)\n- [0.8.0](/php/docs/reference/cloud-dataplex/0.8.0/V1.GetEntityRequest)\n- [0.7.0](/php/docs/reference/cloud-dataplex/0.7.0/V1.GetEntityRequest)\n- [0.6.0](/php/docs/reference/cloud-dataplex/0.6.0/V1.GetEntityRequest)\n- [0.5.1](/php/docs/reference/cloud-dataplex/0.5.1/V1.GetEntityRequest)\n- [0.4.0](/php/docs/reference/cloud-dataplex/0.4.0/V1.GetEntityRequest)\n- [0.3.0](/php/docs/reference/cloud-dataplex/0.3.0/V1.GetEntityRequest)\n- [0.2.3](/php/docs/reference/cloud-dataplex/0.2.3/V1.GetEntityRequest)\n- [0.1.6](/php/docs/reference/cloud-dataplex/0.1.6/V1.GetEntityRequest) \nReference documentation and code samples for the Google Cloud Dataplex V1 Client class GetEntityRequest.\n\nGet metadata entity request.\n\nGenerated from protobuf message `google.cloud.dataplex.v1.GetEntityRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Dataplex \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nRequired. The resource name of the entity:\n`projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}.`\n\n### setName\n\nRequired. The resource name of the entity:\n`projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}.`\n\n### getView\n\nOptional. Used to select the subset of entity information to return.\n\nDefaults to `BASIC`.\n\n### setView\n\nOptional. Used to select the subset of entity information to return.\n\nDefaults to `BASIC`.\n\n### static::build"]]
