Google Cloud Ces V1 Client - Class RetrieveToolsRequest (0.3.0)

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

Request message for ToolService.RetrieveTools.

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

Namespace

Google \ Cloud \ Ces \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ toolset string

Required. The name of the toolset to retrieve the tools for. Format: projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}

↳ tool_ids string[]

Optional. The identifiers of the tools to retrieve from the toolset. If empty, all tools in the toolset will be returned.

↳ bypass_persistence_config bool

Optional. If true, the returned tools will contain raw descriptions and schemas directly from the server, bypassing any stored persistence configurations (overrides/snapshots).

getToolset

Required. The name of the toolset to retrieve the tools for.

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

Returns
Type Description
string

setToolset

Required. The name of the toolset to retrieve the tools for.

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

Parameter
Name Description
var string
Returns
Type Description
$this

getToolIds

Optional. The identifiers of the tools to retrieve from the toolset.

If empty, all tools in the toolset will be returned.

Returns
Type Description
Google\Protobuf\RepeatedField<string>

setToolIds

Optional. The identifiers of the tools to retrieve from the toolset.

If empty, all tools in the toolset will be returned.

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

getBypassPersistenceConfig

Optional. If true, the returned tools will contain raw descriptions and schemas directly from the server, bypassing any stored persistence configurations (overrides/snapshots).

Returns
Type Description
bool

setBypassPersistenceConfig

Optional. If true, the returned tools will contain raw descriptions and schemas directly from the server, bypassing any stored persistence configurations (overrides/snapshots).

Parameter
Name Description
var bool
Returns
Type Description
$this