Reference documentation and code samples for the Google Cloud Dataplex V1 Client class UpdateEntityRequest.
Update a metadata entity request.
The exiting entity will be fully replaced by the entity in the request. The entity ID is mutable. To modify the ID, use the current entity ID in the request URL and specify the new ID in the request body.
Generated from protobuf message google.cloud.dataplex.v1.UpdateEntityRequest
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ entity |
Google\Cloud\Dataplex\V1\Entity
Required. Update description. |
↳ validate_only |
bool
Optional. Only validate the request, but do not perform mutations. The default is false. |
getEntity
Required. Update description.
Generated from protobuf field .google.cloud.dataplex.v1.Entity entity = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataplex\V1\Entity|null | |
hasEntity
clearEntity
setEntity
Required. Update description.
Generated from protobuf field .google.cloud.dataplex.v1.Entity entity = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dataplex\V1\Entity
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getValidateOnly
Optional. Only validate the request, but do not perform mutations.
The default is false.
Generated from protobuf field bool validate_only = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
bool | |
setValidateOnly
Optional. Only validate the request, but do not perform mutations.
The default is false.
Generated from protobuf field bool validate_only = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |