Google Cloud Discovery Engine V1 Client - Class UpdateWidgetConfigRequest (1.17.0)

Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class UpdateWidgetConfigRequest.

Request for WidgetConfigService.UpdateWidgetConfig method.

Generated from protobuf message google.cloud.discoveryengine.v1.UpdateWidgetConfigRequest

Namespace

Google \ Cloud \ DiscoveryEngine \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ widget_config WidgetConfig

Required. The WidgetConfig to update. If the caller does not have permission to update the WidgetConfig, then a PERMISSION_DENIED error is returned. If the WidgetConfig to update does not exist, a NOT_FOUND error is returned.

↳ update_mask Google\Protobuf\FieldMask

Indicates which fields in the provided WidgetConfig to update. The following are the only supported fields: * * WidgetConfig.enable_autocomplete If not set, all supported fields are updated.

getWidgetConfig

Required. The WidgetConfig to update.

If the caller does not have permission to update the WidgetConfig, then a PERMISSION_DENIED error is returned. If the WidgetConfig to update does not exist, a NOT_FOUND error is returned.

Returns
Type Description
WidgetConfig|null

hasWidgetConfig

clearWidgetConfig

setWidgetConfig

Required. The WidgetConfig to update.

If the caller does not have permission to update the WidgetConfig, then a PERMISSION_DENIED error is returned. If the WidgetConfig to update does not exist, a NOT_FOUND error is returned.

Parameter
Name Description
var WidgetConfig
Returns
Type Description
$this

getUpdateMask

Indicates which fields in the provided WidgetConfig to update. The following are the only supported fields:

  • WidgetConfig.enable_autocomplete If not set, all supported fields are updated.
Returns
Type Description
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

Indicates which fields in the provided WidgetConfig to update. The following are the only supported fields:

  • WidgetConfig.enable_autocomplete If not set, all supported fields are updated.
Parameter
Name Description
var Google\Protobuf\FieldMask
Returns
Type Description
$this

static::build

Parameters
Name Description
widgetConfig WidgetConfig

Required. The WidgetConfig to update.

If the caller does not have permission to update the WidgetConfig, then a PERMISSION_DENIED error is returned.

If the WidgetConfig to update does not exist, a NOT_FOUND error is returned.

updateMask Google\Protobuf\FieldMask

Indicates which fields in the provided WidgetConfig to update. The following are the only supported fields:

    • WidgetConfig.enable_autocomplete

If not set, all supported fields are updated.

Returns
Type Description
UpdateWidgetConfigRequest