Google Cloud Discovery Engine V1 Client - Class UpdateEngineRequest (1.5.1)

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 \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ engine
Engine

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.

↳ update_mask
Google\Protobuf\FieldMask

Indicates 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
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
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

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
Returns
Type
Description
$this

static::build

Parameters
Name
Description
engine
Engine

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.

updateMask
Google\Protobuf\FieldMask

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
Design a Mobile Site
View Site in Mobile | Classic
Share by: