Represents a Playbook.
Package
@google-cloud/dialogflow-cxConstructors
(constructor)(properties)
constructor(properties?: google.cloud.dialogflow.cx.v3.IPlaybook);Constructs a new Playbook.
| Parameter | |
|---|---|
| Name | Description |
properties |
IPlaybook
Properties to set |
Properties
codeBlock
public codeBlock?: (google.cloud.dialogflow.cx.v3.ICodeBlock|null);Playbook codeBlock.
createTime
public createTime?: (google.protobuf.ITimestamp|null);Playbook createTime.
displayName
public displayName: string;Playbook displayName.
goal
public goal: string;Playbook goal.
handlers
public handlers: google.cloud.dialogflow.cx.v3.IHandler[];Playbook handlers.
inlineActions
public inlineActions: string[];Playbook inlineActions.
inputParameterDefinitions
public inputParameterDefinitions: google.cloud.dialogflow.cx.v3.IParameterDefinition[];Playbook inputParameterDefinitions.
instruction
public instruction?: (google.cloud.dialogflow.cx.v3.Playbook.IInstruction|null);Playbook instruction.
llmModelSettings
public llmModelSettings?: (google.cloud.dialogflow.cx.v3.ILlmModelSettings|null);Playbook llmModelSettings.
name
public name: string;Playbook name.
outputParameterDefinitions
public outputParameterDefinitions: google.cloud.dialogflow.cx.v3.IParameterDefinition[];Playbook outputParameterDefinitions.
playbookType
public playbookType: (google.cloud.dialogflow.cx.v3.Playbook.PlaybookType|keyof typeof google.cloud.dialogflow.cx.v3.Playbook.PlaybookType);Playbook playbookType.
referencedFlows
public referencedFlows: string[];Playbook referencedFlows.
referencedPlaybooks
public referencedPlaybooks: string[];Playbook referencedPlaybooks.
referencedTools
public referencedTools: string[];Playbook referencedTools.
tokenCount
public tokenCount: (number|Long|string);Playbook tokenCount.
updateTime
public updateTime?: (google.protobuf.ITimestamp|null);Playbook updateTime.
Methods
create(properties)
public static create(properties?: google.cloud.dialogflow.cx.v3.IPlaybook): google.cloud.dialogflow.cx.v3.Playbook;Creates a new Playbook instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IPlaybook
Properties to set |
| Returns | |
|---|---|
| Type | Description |
Playbook |
Playbook instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.dialogflow.cx.v3.Playbook;Decodes a Playbook message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
Playbook |
Playbook |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.dialogflow.cx.v3.Playbook;Decodes a Playbook message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
Playbook |
Playbook |
encode(message, writer)
public static encode(message: google.cloud.dialogflow.cx.v3.IPlaybook, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Playbook message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IPlaybook
Playbook message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.dialogflow.cx.v3.IPlaybook, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Playbook message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IPlaybook
Playbook message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.dialogflow.cx.v3.Playbook;Creates a Playbook message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
Playbook |
Playbook |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Playbook
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string |
The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this Playbook to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.cloud.dialogflow.cx.v3.Playbook, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a Playbook message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
Playbook
Playbook |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a Playbook message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|