Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class UpdateEngineRequest.
Request message for EngineService.UpdateEngine method.
Generated from protobuf message google.cloud.discoveryengine.v1.UpdateEngineRequest
Namespace
Google \ Cloud \ DiscoveryEngine \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data | arrayOptional. Data for populating the Message object. |
↳ engine | Google\Cloud\DiscoveryEngine\V1\EngineRequired. The Engine to update. If the caller does not have permission to update the Engine, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Engine to update does not exist, a NOT_FOUND error is returned. |
↳ update_mask | Google\Protobuf\FieldMaskIndicates which fields in the provided Engine to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. |
getEngine
Required. The Engine to update.
If the caller does not have permission to update the Engine, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Engine to update does not exist, a NOT_FOUND error is returned.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\DiscoveryEngine\V1\Engine|null | |
hasEngine
clearEngine
setEngine
Required. The Engine to update.
If the caller does not have permission to update the Engine, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Engine to update does not exist, a NOT_FOUND error is returned.
| Parameter | |
|---|---|
| Name | Description |
var | Google\Cloud\DiscoveryEngine\V1\Engine |
| Returns | |
|---|---|
| Type | Description |
$this | |
getUpdateMask
Indicates which fields in the provided Engine to update.
If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\FieldMask|null | |
hasUpdateMask
clearUpdateMask
setUpdateMask
Indicates which fields in the provided Engine to update.
If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.
| Parameter | |
|---|---|
| Name | Description |
var | Google\Protobuf\FieldMask |
| Returns | |
|---|---|
| Type | Description |
$this | |
static::build
| Parameters | |
|---|---|
| Name | Description |
engine | Google\Cloud\DiscoveryEngine\V1\EngineRequired. The Engine to update. If the caller does not have permission to update the Engine, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Engine to update does not exist, a NOT_FOUND error is returned. |
updateMask | Google\Protobuf\FieldMaskIndicates which fields in the provided Engine to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\DiscoveryEngine\V1\UpdateEngineRequest | |