Google Cloud Ces V1 Client - Class RetrieveToolSchemaRequest (0.1.0)

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

Request message for ToolService.RetrieveToolSchema.

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

Namespace

Google \ Cloud \ Ces \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ tool string

Optional. The name of the tool to retrieve the schema for. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}

↳ toolset_tool ToolsetTool

Optional. The toolset tool to retrieve the schema for. Only one tool should match the predicate from the toolset. Otherwise, an error will be returned.

↳ parent string

Required. The resource name of the app which the tool/toolset belongs to. Format: projects/{project}/locations/{location}/apps/{app}

getTool

Optional. The name of the tool to retrieve the schema for.

Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}

Returns
Type Description
string

hasTool

setTool

Optional. The name of the tool to retrieve the schema for.

Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}

Parameter
Name Description
var string
Returns
Type Description
$this

getToolsetTool

Optional. The toolset tool to retrieve the schema for. Only one tool should match the predicate from the toolset. Otherwise, an error will be returned.

Returns
Type Description
ToolsetTool|null

hasToolsetTool

setToolsetTool

Optional. The toolset tool to retrieve the schema for. Only one tool should match the predicate from the toolset. Otherwise, an error will be returned.

Parameter
Name Description
var ToolsetTool
Returns
Type Description
$this

getParent

Required. The resource name of the app which the tool/toolset belongs to.

Format: projects/{project}/locations/{location}/apps/{app}

Returns
Type Description
string

setParent

Required. The resource name of the app which the tool/toolset belongs to.

Format: projects/{project}/locations/{location}/apps/{app}

Parameter
Name Description
var string
Returns
Type Description
$this

getToolIdentifier

Returns
Type Description
string