Constructor
new Playbook(propertiesopt)
Constructs a new Playbook.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.dialogflow.cx.v3beta1.IPlaybook |
<optional> |
Properties to set |
- Implements:
-
- IPlaybook
Classes
Members
createTime
Playbook createTime.
displayName
Playbook displayName.
goal
Playbook goal.
inputParameterDefinitions
Playbook inputParameterDefinitions.
instruction
Playbook instruction.
llmModelSettings
Playbook llmModelSettings.
name
Playbook name.
outputParameterDefinitions
Playbook outputParameterDefinitions.
referencedFlows
Playbook referencedFlows.
referencedPlaybooks
Playbook referencedPlaybooks.
referencedTools
Playbook referencedTools.
tokenCount
Playbook tokenCount.
updateTime
Playbook updateTime.
Methods
toJSON() → {Object.<string, *>}
Converts this Playbook to JSON.
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
JSON object |
(static) create(propertiesopt) → {google.cloud.dialogflow.cx.v3beta1.Playbook}
Creates a new Playbook instance using the specified properties.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.dialogflow.cx.v3beta1.IPlaybook |
<optional> |
Properties to set |
Returns:
| Type | Description |
|---|---|
| google.cloud.dialogflow.cx.v3beta1.Playbook |
Playbook instance |
(static) decode(reader, lengthopt) → {google.cloud.dialogflow.cx.v3beta1.Playbook}
Decodes a Playbook message from the specified reader or buffer.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
reader |
$protobuf.Reader | Uint8Array |
Reader or buffer to decode from |
|
length |
number |
<optional> |
Message length if known beforehand |
Returns:
| Type | Description |
|---|---|
| google.cloud.dialogflow.cx.v3beta1.Playbook |
Playbook |
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
(static) decodeDelimited(reader) → {google.cloud.dialogflow.cx.v3beta1.Playbook}
Decodes a Playbook message from the specified reader or buffer, length delimited.
Parameters:
| Name | Type | Description |
|---|---|---|
reader |
$protobuf.Reader | Uint8Array |
Reader or buffer to decode from |
Returns:
| Type | Description |
|---|---|
| google.cloud.dialogflow.cx.v3beta1.Playbook |
Playbook |
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
(static) encode(message, writeropt) → {$protobuf.Writer}
Encodes the specified Playbook message. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.dialogflow.cx.v3beta1.IPlaybook |
Playbook message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}
Encodes the specified Playbook message, length delimited. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.dialogflow.cx.v3beta1.IPlaybook |
Playbook message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(static) fromObject(object) → {google.cloud.dialogflow.cx.v3beta1.Playbook}
Creates a Playbook message from a plain object. Also converts values to their respective internal types.
Parameters:
| Name | Type | Description |
|---|---|---|
object |
Object.<string, *> |
Plain object |
Returns:
| Type | Description |
|---|---|
| google.cloud.dialogflow.cx.v3beta1.Playbook |
Playbook |
(static) getTypeUrl(typeUrlPrefixopt) → {string}
Gets the default type url for Playbook
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
typeUrlPrefix |
string |
<optional> |
your custom typeUrlPrefix(default "type.googleapis.com") |
Returns:
| Type | Description |
|---|---|
| string |
The default type url |
(static) toObject(message, optionsopt) → {Object.<string, *>}
Creates a plain object from a Playbook message. Also converts values to other types if specified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.dialogflow.cx.v3beta1.Playbook |
Playbook |
|
options |
$protobuf.IConversionOptions |
<optional> |
Conversion options |
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
Plain object |
(static) verify(message) → {string|null}
Verifies a Playbook message.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Object.<string, *> |
Plain object to verify |
Returns:
| Type | Description |
|---|---|
| string | null |
|