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

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

Informations to support actions on the connector.

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

Namespace

Google \ Cloud \ DiscoveryEngine \ V1

Methods

__construct

Constructor.

Parameter
Name Description
data mixed

getActionParams

Optional. Action parameters in structured json format.

Returns
Type Description
Google\Protobuf\Struct|null

hasActionParams

setActionParams

Optional. Action parameters in structured json format.

Parameter
Name Description
var Google\Protobuf\Struct
Returns
Type Description
$this

getJsonActionParams

Optional. Action parameters in json string format.

Returns
Type Description
string

hasJsonActionParams

setJsonActionParams

Optional. Action parameters in json string format.

Parameter
Name Description
var string
Returns
Type Description
$this

getIsActionConfigured

Output only. The connector contains the necessary parameters and is configured to support actions.

Returns
Type Description
bool

setIsActionConfigured

Output only. The connector contains the necessary parameters and is configured to support actions.

Parameter
Name Description
var bool
Returns
Type Description
$this

getServiceName

Optional. The Service Directory resource name (projects//locations//namespaces//services/) representing a VPC network endpoint used to connect to the data source's instance_uri, defined in DataConnector.params.

Required when VPC Service Controls are enabled.

Returns
Type Description
string

setServiceName

Optional. The Service Directory resource name (projects//locations//namespaces//services/) representing a VPC network endpoint used to connect to the data source's instance_uri, defined in DataConnector.params.

Required when VPC Service Controls are enabled.

Parameter
Name Description
var string
Returns
Type Description
$this

getUseStaticSecrets

Optional. Whether to use static secrets for the connector. If true, the secrets provided in the action_params will be ignored.

Returns
Type Description
bool

setUseStaticSecrets

Optional. Whether to use static secrets for the connector. If true, the secrets provided in the action_params will be ignored.

Parameter
Name Description
var bool
Returns
Type Description
$this

getCreateBapConnection

Optional. Whether to create a BAP connection for the connector.

Returns
Type Description
bool

setCreateBapConnection

Optional. Whether to create a BAP connection for the connector.

Parameter
Name Description
var bool
Returns
Type Description
$this

getUserDefinedScopesMapping

Optional. Mapping from operation name to the list of scopes. Only be populated if there are user specified scopes.

Returns
Type Description
Google\Protobuf\Internal\MapField

setUserDefinedScopesMapping

Optional. Mapping from operation name to the list of scopes. Only be populated if there are user specified scopes.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getActionConfigParams

Returns
Type Description
string