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

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

Represents a single reusable computational or logical unit.

Generated from protobuf message google.cloud.discoveryengine.v1.WidgetConfig.Node

Namespace

Google \ Cloud \ DiscoveryEngine \ V1 \ WidgetConfig

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ display_name string

Output only. A human readable name for the node.

↳ icon_url string

Output only. An identifier or URL pointing to an icon representing this node type.

↳ description string

Output only. A detailed description of what the node does.

↳ parameter_schema Google\Protobuf\Struct

Output only. The parameter schema of the tool. This schema is expected to conform to the OpenAPI Schema standard (see https://spec.openapis.org/oas/v3.0.3.html and AIP-146). It describes the expected structure of the parameters that this node accepts.

↳ output_schema Google\Protobuf\Struct

Output only. The output schema of the tool. This schema is expected to conform to the OpenAPI Schema standard (see https://spec.openapis.org/oas/v3.0.3.html/ and AIP-146). It describes the structure of the output produced by this node.

↳ type int

Output only. The type of the node.

getDisplayName

Output only. A human readable name for the node.

Returns
Type Description
string

setDisplayName

Output only. A human readable name for the node.

Parameter
Name Description
var string
Returns
Type Description
$this

getIconUrl

Output only. An identifier or URL pointing to an icon representing this node type.

Returns
Type Description
string

setIconUrl

Output only. An identifier or URL pointing to an icon representing this node type.

Parameter
Name Description
var string
Returns
Type Description
$this

getDescription

Output only. A detailed description of what the node does.

Returns
Type Description
string

setDescription

Output only. A detailed description of what the node does.

Parameter
Name Description
var string
Returns
Type Description
$this

getParameterSchema

Output only. The parameter schema of the tool.

This schema is expected to conform to the OpenAPI Schema standard (see https://spec.openapis.org/oas/v3.0.3.html and AIP-146). It describes the expected structure of the parameters that this node accepts.

Returns
Type Description
Google\Protobuf\Struct|null

hasParameterSchema

clearParameterSchema

setParameterSchema

Output only. The parameter schema of the tool.

This schema is expected to conform to the OpenAPI Schema standard (see https://spec.openapis.org/oas/v3.0.3.html and AIP-146). It describes the expected structure of the parameters that this node accepts.

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

getOutputSchema

Output only. The output schema of the tool.

This schema is expected to conform to the OpenAPI Schema standard (see https://spec.openapis.org/oas/v3.0.3.html/ and AIP-146). It describes the structure of the output produced by this node.

Returns
Type Description
Google\Protobuf\Struct|null

hasOutputSchema

clearOutputSchema

setOutputSchema

Output only. The output schema of the tool.

This schema is expected to conform to the OpenAPI Schema standard (see https://spec.openapis.org/oas/v3.0.3.html/ and AIP-146). It describes the structure of the output produced by this node.

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

getType

Output only. The type of the node.

Returns
Type Description
int Enum of type Type.

setType

Output only. The type of the node.

Parameter
Name Description
var int

Enum of type Type.

Returns
Type Description
$this