Google Cloud Ces V1 Client - Class ConnectorTool (0.1.0)

Reference documentation and code samples for the Google Cloud Ces V1 Client class ConnectorTool.

A ConnectorTool allows connections to different integrations.

See: https://cloud.google.com/integration-connectors/docs/overview.

Generated from protobuf message google.cloud.ces.v1.ConnectorTool

Namespace

Google \ Cloud \ Ces \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ connection`	`string` Required. The full resource name of the referenced Integration Connectors Connection. Format: `projects/{project}/locations/{location}/connections/{connection}`
`↳ action`	`Action` Required. Action for the tool to use.
`↳ auth_config`	`EndUserAuthConfig` Optional. Configures how authentication is handled in Integration Connectors. By default, an admin authentication is passed in the Integration Connectors API requests. You can override it with a different end-user authentication config. Note: The Connection must have authentication override enabled in order to specify an EUC configuration here - otherwise, the ConnectorTool creation will fail. See https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override for details.
`↳ name`	`string` Optional. The name of the tool that can be used by the Agent to decide whether to call this ConnectorTool.
`↳ description`	`string` Optional. The description of the tool that can be used by the Agent to decide whether to call this ConnectorTool.

getConnection

Required. The full resource name of the referenced Integration Connectors Connection.

Format: projects/{project}/locations/{location}/connections/{connection}

Returns
Type	Description
`string`

setConnection

Required. The full resource name of the referenced Integration Connectors Connection.

Format: projects/{project}/locations/{location}/connections/{connection}

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getAction

Required. Action for the tool to use.

Returns
Type	Description
`Action\|null`

hasAction

clearAction

setAction

Required. Action for the tool to use.

Parameter
Name	Description
`var`	`Action`

Returns
Type	Description
`$this`

getAuthConfig

Optional. Configures how authentication is handled in Integration Connectors. By default, an admin authentication is passed in the Integration Connectors API requests. You can override it with a different end-user authentication config.

Note: The Connection must have authentication override enabled in order to specify an EUC configuration here - otherwise, the ConnectorTool creation will fail. See https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override for details.

Returns
Type	Description
`EndUserAuthConfig\|null`

hasAuthConfig

clearAuthConfig

setAuthConfig

Parameter
Name	Description
`var`	`EndUserAuthConfig`

Returns
Type	Description
`$this`

getName

Optional. The name of the tool that can be used by the Agent to decide whether to call this ConnectorTool.

Returns
Type	Description
`string`

setName