Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class AccessSettings.
Describes widget access settings.
Generated from protobuf message google.cloud.discoveryengine.v1.WidgetConfig.AccessSettings
Namespace
Google \ Cloud \ DiscoveryEngine \ V1 \ WidgetConfigMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ allow_public_access |
bool
Whether public unauthenticated access is allowed. |
↳ allowlisted_domains |
string[]
List of domains that are allowed to integrate the search widget. |
↳ enable_web_app |
bool
Whether web app access is enabled. |
↳ workforce_identity_pool_provider |
string
Optional. The workforce identity pool provider used to access the widget. |
↳ language_code |
string
Optional. Language code for user interface. Use language tags defined by BCP47. If unset, the default language code is "en-US". |
getAllowPublicAccess
Whether public unauthenticated access is allowed.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setAllowPublicAccess
Whether public unauthenticated access is allowed.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAllowlistedDomains
List of domains that are allowed to integrate the search widget.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<string> |
|
setAllowlistedDomains
List of domains that are allowed to integrate the search widget.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEnableWebApp
Whether web app access is enabled.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setEnableWebApp
Whether web app access is enabled.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getWorkforceIdentityPoolProvider
Optional. The workforce identity pool provider used to access the widget.
| Returns | |
|---|---|
| Type | Description |
string |
|
setWorkforceIdentityPoolProvider
Optional. The workforce identity pool provider used to access the widget.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLanguageCode
Optional. Language code for user interface. Use language tags defined by BCP47.
If unset, the default language code is "en-US".
| Returns | |
|---|---|
| Type | Description |
string |
|
setLanguageCode
Optional. Language code for user interface. Use language tags defined by BCP47.
If unset, the default language code is "en-US".
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|