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

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

Admin-surface metadata. Populated only when the request originates from the Cloud Console admin "Feature Control" page; left unset for end-user surfaces (Web, Mobile). Lets the admin page render its toggle table directly from the backend instead of a hardcoded client-side registry.

Generated from protobuf message google.cloud.discoveryengine.v1.WidgetConfig.UiSettings.ModelConfigInfo.ResolvedModel.AdminView

Namespace

Google \ Cloud \ DiscoveryEngine \ V1 \ WidgetConfig \ UiSettings \ ModelConfigInfo \ ResolvedModel

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ admin_overridable bool

Output only. Whether the admin can toggle this model's enabled/disabled state via UiSettings.model_configs. Derived from MODEL_TAG_ADMIN_OVERRIDABLE. When false, the model is "forced" and its state is governed by enabled_by_default.

↳ enabled_by_default bool

Output only. Whether the model is enabled when the admin has set no explicit override in UiSettings.model_configs. Derived from MODEL_TAG_ENABLED_BY_DEFAULT.

↳ regions string[]

Output only. Regions where this model is launched.

getAdminOverridable

Output only. Whether the admin can toggle this model's enabled/disabled state via UiSettings.model_configs. Derived from MODEL_TAG_ADMIN_OVERRIDABLE. When false, the model is "forced" and its state is governed by enabled_by_default.

Returns
Type Description
bool

setAdminOverridable

Output only. Whether the admin can toggle this model's enabled/disabled state via UiSettings.model_configs. Derived from MODEL_TAG_ADMIN_OVERRIDABLE. When false, the model is "forced" and its state is governed by enabled_by_default.

Parameter
Name Description
var bool
Returns
Type Description
$this

getEnabledByDefault

Output only. Whether the model is enabled when the admin has set no explicit override in UiSettings.model_configs. Derived from MODEL_TAG_ENABLED_BY_DEFAULT.

Returns
Type Description
bool

setEnabledByDefault

Output only. Whether the model is enabled when the admin has set no explicit override in UiSettings.model_configs. Derived from MODEL_TAG_ENABLED_BY_DEFAULT.

Parameter
Name Description
var bool
Returns
Type Description
$this

getRegions

Output only. Regions where this model is launched.

Returns
Type Description
Google\Protobuf\RepeatedField<string>

setRegions

Output only. Regions where this model is launched.

Parameter
Name Description
var string[]
Returns
Type Description
$this