Playbook (proto-google-cloud-dialogflow-cx-v3beta1 0.71.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - com.google.cloud.dialogflow.cx.v3beta1.Playbook

All Implemented Interfaces:: PlaybookOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class Playbook
extends com.google.protobuf.GeneratedMessageV3
implements PlaybookOrBuilder

 Playbook is the basic building block to instruct the LLM how to execute a
 certain task.

 A playbook consists of a goal to accomplish, an optional list of step by step
 instructions (the step instruction may refers to name of the custom or
 default plugin tools to use) to perform the task,
 a list of contextual input data to be passed in at the beginning of the
 invoked, and a list of output parameters to store the playbook result.

Protobuf type google.cloud.dialogflow.cx.v3beta1.Playbook

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Playbook.Builder` Playbook is the basic building block to instruct the LLM how to execute a certain task.
`static class`	`Playbook.Instruction` Message of the Instruction of the playbook.
`static interface`	`Playbook.InstructionOrBuilder`
`static class`	`Playbook.Step` Message of single step execution.
`static interface`	`Playbook.StepOrBuilder`

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CREATE_TIME_FIELD_NUMBER`
`static int`	`DISPLAY_NAME_FIELD_NUMBER`
`static int`	`GOAL_FIELD_NUMBER`
`static int`	`HANDLERS_FIELD_NUMBER`
`static int`	`INPUT_PARAMETER_DEFINITIONS_FIELD_NUMBER`
`static int`	`INSTRUCTION_FIELD_NUMBER`
`static int`	`LLM_MODEL_SETTINGS_FIELD_NUMBER`
`static int`	`NAME_FIELD_NUMBER`
`static int`	`OUTPUT_PARAMETER_DEFINITIONS_FIELD_NUMBER`
`static int`	`REFERENCED_FLOWS_FIELD_NUMBER`
`static int`	`REFERENCED_PLAYBOOKS_FIELD_NUMBER`
`static int`	`REFERENCED_TOOLS_FIELD_NUMBER`
`static int`	`SPEECH_SETTINGS_FIELD_NUMBER`
`static int`	`TOKEN_COUNT_FIELD_NUMBER`
`static int`	`UPDATE_TIME_FIELD_NUMBER`

Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`com.google.protobuf.Timestamp`	`getCreateTime()` Output only.
`com.google.protobuf.TimestampOrBuilder`	`getCreateTimeOrBuilder()` Output only.
`static Playbook`	`getDefaultInstance()`
`Playbook`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`String`	`getDisplayName()` Required.
`com.google.protobuf.ByteString`	`getDisplayNameBytes()` Required.
`String`	`getGoal()` Required.
`com.google.protobuf.ByteString`	`getGoalBytes()` Required.
`Handler`	`getHandlers(int index)` Optional.
`int`	`getHandlersCount()` Optional.
`List<Handler>`	`getHandlersList()` Optional.
`HandlerOrBuilder`	`getHandlersOrBuilder(int index)` Optional.
`List<? extends HandlerOrBuilder>`	`getHandlersOrBuilderList()` Optional.
`ParameterDefinition`	`getInputParameterDefinitions(int index)` Optional.
`int`	`getInputParameterDefinitionsCount()` Optional.
`List<ParameterDefinition>`	`getInputParameterDefinitionsList()` Optional.
`ParameterDefinitionOrBuilder`	`getInputParameterDefinitionsOrBuilder(int index)` Optional.
`List<? extends ParameterDefinitionOrBuilder>`	`getInputParameterDefinitionsOrBuilderList()` Optional.
`Playbook.Instruction`	`getInstruction()` Instruction to accomplish target goal.
`Playbook.InstructionOrBuilder`	`getInstructionOrBuilder()` Instruction to accomplish target goal.
`LlmModelSettings`	`getLlmModelSettings()` Optional.
`LlmModelSettingsOrBuilder`	`getLlmModelSettingsOrBuilder()` Optional.
`String`	`getName()` The unique identifier of the playbook.
`com.google.protobuf.ByteString`	`getNameBytes()` The unique identifier of the playbook.
`ParameterDefinition`	`getOutputParameterDefinitions(int index)` Optional.
`int`	`getOutputParameterDefinitionsCount()` Optional.
`List<ParameterDefinition>`	`getOutputParameterDefinitionsList()` Optional.
`ParameterDefinitionOrBuilder`	`getOutputParameterDefinitionsOrBuilder(int index)` Optional.
`List<? extends ParameterDefinitionOrBuilder>`	`getOutputParameterDefinitionsOrBuilderList()` Optional.
`com.google.protobuf.Parser<Playbook>`	`getParserForType()`
`String`	`getReferencedFlows(int index)` Output only.
`com.google.protobuf.ByteString`	`getReferencedFlowsBytes(int index)` Output only.
`int`	`getReferencedFlowsCount()` Output only.
`com.google.protobuf.ProtocolStringList`	`getReferencedFlowsList()` Output only.
`String`	`getReferencedPlaybooks(int index)` Output only.
`com.google.protobuf.ByteString`	`getReferencedPlaybooksBytes(int index)` Output only.
`int`	`getReferencedPlaybooksCount()` Output only.
`com.google.protobuf.ProtocolStringList`	`getReferencedPlaybooksList()` Output only.
`String`	`getReferencedTools(int index)` Optional.
`com.google.protobuf.ByteString`	`getReferencedToolsBytes(int index)` Optional.
`int`	`getReferencedToolsCount()` Optional.
`com.google.protobuf.ProtocolStringList`	`getReferencedToolsList()` Optional.
`int`	`getSerializedSize()`
`AdvancedSettings.SpeechSettings`	`getSpeechSettings()` Optional.
`AdvancedSettings.SpeechSettingsOrBuilder`	`getSpeechSettingsOrBuilder()` Optional.
`long`	`getTokenCount()` Output only.
`com.google.protobuf.Timestamp`	`getUpdateTime()` Output only.
`com.google.protobuf.TimestampOrBuilder`	`getUpdateTimeOrBuilder()` Output only.
`boolean`	`hasCreateTime()` Output only.
`int`	`hashCode()`
`boolean`	`hasInstruction()` Instruction to accomplish target goal.
`boolean`	`hasLlmModelSettings()` Optional.
`boolean`	`hasSpeechSettings()` Optional.
`boolean`	`hasUpdateTime()` Output only.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`static Playbook.Builder`	`newBuilder()`
`static Playbook.Builder`	`newBuilder(Playbook prototype)`
`Playbook.Builder`	`newBuilderForType()`
`protected Playbook.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`protected Object`	`newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)`
`static Playbook`	`parseDelimitedFrom(InputStream input)`
`static Playbook`	`parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Playbook`	`parseFrom(byte[] data)`
`static Playbook`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Playbook`	`parseFrom(ByteBuffer data)`
`static Playbook`	`parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Playbook`	`parseFrom(com.google.protobuf.ByteString data)`
`static Playbook`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Playbook`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static Playbook`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Playbook`	`parseFrom(InputStream input)`
`static Playbook`	`parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<Playbook>`	`parser()`
`Playbook.Builder`	`toBuilder()`
`void`	`writeTo(com.google.protobuf.CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

- Field Detail
  - NAME_FIELD_NUMBER
```
public static final int NAME_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - DISPLAY_NAME_FIELD_NUMBER
```
public static final int DISPLAY_NAME_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - GOAL_FIELD_NUMBER
```
public static final int GOAL_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - INPUT_PARAMETER_DEFINITIONS_FIELD_NUMBER
```
public static final int INPUT_PARAMETER_DEFINITIONS_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - OUTPUT_PARAMETER_DEFINITIONS_FIELD_NUMBER
```
public static final int OUTPUT_PARAMETER_DEFINITIONS_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - INSTRUCTION_FIELD_NUMBER
```
public static final int INSTRUCTION_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - TOKEN_COUNT_FIELD_NUMBER
```
public static final int TOKEN_COUNT_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - CREATE_TIME_FIELD_NUMBER
```
public static final int CREATE_TIME_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - UPDATE_TIME_FIELD_NUMBER
```
public static final int UPDATE_TIME_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - REFERENCED_PLAYBOOKS_FIELD_NUMBER
```
public static final int REFERENCED_PLAYBOOKS_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - REFERENCED_FLOWS_FIELD_NUMBER
```
public static final int REFERENCED_FLOWS_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - REFERENCED_TOOLS_FIELD_NUMBER
```
public static final int REFERENCED_TOOLS_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - LLM_MODEL_SETTINGS_FIELD_NUMBER
```
public static final int LLM_MODEL_SETTINGS_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - SPEECH_SETTINGS_FIELD_NUMBER
```
public static final int SPEECH_SETTINGS_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - HANDLERS_FIELD_NUMBER
```
public static final int HANDLERS_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
- Method Detail
  - newInstance
```
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
```
    Overrides:
    
    newInstance in class com.google.protobuf.GeneratedMessageV3
  - getDescriptor
```
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
```
  - internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
    Specified by:
    
    internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
  - getName
```
public String getName()
```
```
 The unique identifier of the playbook.
 Format:
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>`.
 
```
    string name = 1;
    Specified by:
    
    getName in interface PlaybookOrBuilder
    
    Returns:
    
    The name.
  - getNameBytes
```
public com.google.protobuf.ByteString getNameBytes()
```
```
 The unique identifier of the playbook.
 Format:
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>`.
 
```
    string name = 1;
    Specified by:
    
    getNameBytes in interface PlaybookOrBuilder
    
    Returns:
    
    The bytes for name.
  - getDisplayName
```
public String getDisplayName()
```
```
 Required. The human-readable name of the playbook, unique within an agent.
 
```
    string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
    Specified by:
    
    getDisplayName in interface PlaybookOrBuilder
    
    Returns:
    
    The displayName.
  - getDisplayNameBytes
```
public com.google.protobuf.ByteString getDisplayNameBytes()
```
```
 Required. The human-readable name of the playbook, unique within an agent.
 
```
    string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
    Specified by:
    
    getDisplayNameBytes in interface PlaybookOrBuilder
    
    Returns:
    
    The bytes for displayName.
  - getGoal
```
public String getGoal()
```
```
 Required. High level description of the goal the playbook intend to
 accomplish. A goal should be concise since it's visible to other playbooks
 that may reference this playbook.
 
```
    string goal = 3 [(.google.api.field_behavior) = REQUIRED];
    Specified by:
    
    getGoal in interface PlaybookOrBuilder
    
    Returns:
    
    The goal.
  - getGoalBytes
```
public com.google.protobuf.ByteString getGoalBytes()
```
```
 Required. High level description of the goal the playbook intend to
 accomplish. A goal should be concise since it's visible to other playbooks
 that may reference this playbook.
 
```
    string goal = 3 [(.google.api.field_behavior) = REQUIRED];
    Specified by:
    
    getGoalBytes in interface PlaybookOrBuilder
    
    Returns:
    
    The bytes for goal.
  - getInputParameterDefinitionsList
```
public List<ParameterDefinition> getInputParameterDefinitionsList()
```
```
 Optional. Defined structured input parameters for this playbook.
 
```
    repeated .google.cloud.dialogflow.cx.v3beta1.ParameterDefinition input_parameter_definitions = 5 [(.google.api.field_behavior) = OPTIONAL];
    Specified by:
    
    getInputParameterDefinitionsList in interface PlaybookOrBuilder
  - getInputParameterDefinitionsOrBuilderList
```
public List<? extends ParameterDefinitionOrBuilder> getInputParameterDefinitionsOrBuilderList()
```
```
 Optional. Defined structured input parameters for this playbook.
 
```
    repeated .google.cloud.dialogflow.cx.v3beta1.ParameterDefinition input_parameter_definitions = 5 [(.google.api.field_behavior) = OPTIONAL];
    Specified by:
    
    getInputParameterDefinitionsOrBuilderList in interface PlaybookOrBuilder
  - getInputParameterDefinitionsCount
```
public int getInputParameterDefinitionsCount()
```
```
 Optional. Defined structured input parameters for this playbook.
 
```
    repeated .google.cloud.dialogflow.cx.v3beta1.ParameterDefinition input_parameter_definitions = 5 [(.google.api.field_behavior) = OPTIONAL];
    Specified by:
    
    getInputParameterDefinitionsCount in interface PlaybookOrBuilder
  - getInputParameterDefinitions
```
public ParameterDefinition getInputParameterDefinitions(int index)
```
```
 Optional. Defined structured input parameters for this playbook.
 
```
    repeated .google.cloud.dialogflow.cx.v3beta1.ParameterDefinition input_parameter_definitions = 5 [(.google.api.field_behavior) = OPTIONAL];
    Specified by:
    
    getInputParameterDefinitions in interface PlaybookOrBuilder
  - getInputParameterDefinitionsOrBuilder
```
public ParameterDefinitionOrBuilder getInputParameterDefinitionsOrBuilder(int index)
```
```
 Optional. Defined structured input parameters for this playbook.
 
```
    repeated .google.cloud.dialogflow.cx.v3beta1.ParameterDefinition input_parameter_definitions = 5 [(.google.api.field_behavior) = OPTIONAL];
    Specified by:
    
    getInputParameterDefinitionsOrBuilder in interface PlaybookOrBuilder
  - getOutputParameterDefinitionsList
```
public List<ParameterDefinition> getOutputParameterDefinitionsList()
```
```
 Optional. Defined structured output parameters for this playbook.
 
```
    repeated .google.cloud.dialogflow.cx.v3beta1.ParameterDefinition output_parameter_definitions = 6 [(.google.api.field_behavior) = OPTIONAL];
    Specified by:
    
    getOutputParameterDefinitionsList in interface PlaybookOrBuilder
  - getOutputParameterDefinitionsOrBuilderList
```
public List<? extends ParameterDefinitionOrBuilder> getOutputParameterDefinitionsOrBuilderList()
```
```
 Optional. Defined structured output parameters for this playbook.
 
```
    repeated .google.cloud.dialogflow.cx.v3beta1.ParameterDefinition output_parameter_definitions = 6 [(.google.api.field_behavior) = OPTIONAL];
    Specified by:
    
    getOutputParameterDefinitionsOrBuilderList in interface PlaybookOrBuilder
  - getOutputParameterDefinitionsCount
```
public int getOutputParameterDefinitionsCount()
```
```
 Optional. Defined structured output parameters for this playbook.
 
```
    repeated .google.cloud.dialogflow.cx.v3beta1.ParameterDefinition output_parameter_definitions = 6 [(.google.api.field_behavior) = OPTIONAL];
    Specified by:
    
    getOutputParameterDefinitionsCount in interface PlaybookOrBuilder
  - getOutputParameterDefinitions
```
public ParameterDefinition getOutputParameterDefinitions(int index)
```
```
 Optional. Defined structured output parameters for this playbook.
 
```
    repeated .google.cloud.dialogflow.cx.v3beta1.ParameterDefinition output_parameter_definitions = 6 [(.google.api.field_behavior) = OPTIONAL];
    Specified by:
    
    getOutputParameterDefinitions in interface PlaybookOrBuilder
  - getOutputParameterDefinitionsOrBuilder
```
public ParameterDefinitionOrBuilder getOutputParameterDefinitionsOrBuilder(int index)
```
```
 Optional. Defined structured output parameters for this playbook.
 
```
    repeated .google.cloud.dialogflow.cx.v3beta1.ParameterDefinition output_parameter_definitions = 6 [(.google.api.field_behavior) = OPTIONAL];
    Specified by:
    
    getOutputParameterDefinitionsOrBuilder in interface PlaybookOrBuilder
  - hasInstruction
```
public boolean hasInstruction()
```
```
 Instruction to accomplish target goal.
 
```
    .google.cloud.dialogflow.cx.v3beta1.Playbook.Instruction instruction = 17;
    Specified by:
    
    hasInstruction in interface PlaybookOrBuilder
    
    Returns:
    
    Whether the instruction field is set.
  - getInstruction
```
public Playbook.Instruction getInstruction()
```
```
 Instruction to accomplish target goal.
 
```
    .google.cloud.dialogflow.cx.v3beta1.Playbook.Instruction instruction = 17;
    Specified by:
    
    getInstruction in interface PlaybookOrBuilder
    
    Returns:
    
    The instruction.
  - getInstructionOrBuilder
```
public Playbook.InstructionOrBuilder getInstructionOrBuilder()
```
```
 Instruction to accomplish target goal.
 
```
    .google.cloud.dialogflow.cx.v3beta1.Playbook.Instruction instruction = 17;
    Specified by:
    
    getInstructionOrBuilder in interface PlaybookOrBuilder
  - getTokenCount
```
public long getTokenCount()
```
```
 Output only. Estimated number of tokes current playbook takes when sent to
 the LLM.
 
```
    int64 token_count = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Specified by:
    
    getTokenCount in interface PlaybookOrBuilder
    
    Returns:
    
    The tokenCount.
  - hasCreateTime
```
public boolean hasCreateTime()
```
```
 Output only. The timestamp of initial playbook creation.
 
```
    .google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Specified by:
    
    hasCreateTime in interface PlaybookOrBuilder
    
    Returns:
    
    Whether the createTime field is set.
  - getCreateTime
```
public com.google.protobuf.Timestamp getCreateTime()
```
```
 Output only. The timestamp of initial playbook creation.
 
```
    .google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Specified by:
    
    getCreateTime in interface PlaybookOrBuilder
    
    Returns:
    
    The createTime.
  - getCreateTimeOrBuilder
```
public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
```
```
 Output only. The timestamp of initial playbook creation.
 
```
    .google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Specified by:
    
    getCreateTimeOrBuilder in interface PlaybookOrBuilder
  - hasUpdateTime
```
public boolean hasUpdateTime()
```
```
 Output only. Last time the playbook version was updated.
 
```
    .google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Specified by:
    
    hasUpdateTime in interface PlaybookOrBuilder
    
    Returns:
    
    Whether the updateTime field is set.
  - getUpdateTime
```
public com.google.protobuf.Timestamp getUpdateTime()
```
```
 Output only. Last time the playbook version was updated.
 
```
    .google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Specified by:
    
    getUpdateTime in interface PlaybookOrBuilder
    
    Returns:
    
    The updateTime.
  - getUpdateTimeOrBuilder
```
public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
```
```
 Output only. Last time the playbook version was updated.
 
```
    .google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Specified by:
    
    getUpdateTimeOrBuilder in interface PlaybookOrBuilder
  - getReferencedPlaybooksList
```
public com.google.protobuf.ProtocolStringList getReferencedPlaybooksList()
```
```
 Output only. The resource name of other playbooks referenced by the current
 playbook in the instructions.
 
```
    repeated string referenced_playbooks = 11 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
    Specified by:
    
    getReferencedPlaybooksList in interface PlaybookOrBuilder
    
    Returns:
    
    A list containing the referencedPlaybooks.
  - getReferencedPlaybooksCount
```
public int getReferencedPlaybooksCount()
```
```
 Output only. The resource name of other playbooks referenced by the current
 playbook in the instructions.
 
```
    repeated string referenced_playbooks = 11 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
    Specified by:
    
    getReferencedPlaybooksCount in interface PlaybookOrBuilder
    
    Returns:
    
    The count of referencedPlaybooks.
  - getReferencedPlaybooks
```
public String getReferencedPlaybooks(int index)
```
```
 Output only. The resource name of other playbooks referenced by the current
 playbook in the instructions.
 
```
    repeated string referenced_playbooks = 11 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
    Specified by:
    
    getReferencedPlaybooks in interface PlaybookOrBuilder
    
    Parameters:
    
    index - The index of the element to return.
    
    Returns:
    
    The referencedPlaybooks at the given index.
  - getReferencedPlaybooksBytes
```
public com.google.protobuf.ByteString getReferencedPlaybooksBytes(int index)
```
```
 Output only. The resource name of other playbooks referenced by the current
 playbook in the instructions.
 
```
    repeated string referenced_playbooks = 11 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
    Specified by:
    
    getReferencedPlaybooksBytes in interface PlaybookOrBuilder
    
    Parameters:
    
    index - The index of the value to return.
    
    Returns:
    
    The bytes of the referencedPlaybooks at the given index.
  - getReferencedFlowsList
```
public com.google.protobuf.ProtocolStringList getReferencedFlowsList()
```
```
 Output only. The resource name of flows referenced by the current playbook
 in the instructions.
 
```
    repeated string referenced_flows = 12 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
    Specified by:
    
    getReferencedFlowsList in interface PlaybookOrBuilder
    
    Returns:
    
    A list containing the referencedFlows.
  - getReferencedFlowsCount
```
public int getReferencedFlowsCount()
```
```
 Output only. The resource name of flows referenced by the current playbook
 in the instructions.
 
```
    repeated string referenced_flows = 12 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
    Specified by:
    
    getReferencedFlowsCount in interface PlaybookOrBuilder
    
    Returns:
    
    The count of referencedFlows.
  - getReferencedFlows
```
public String getReferencedFlows(int index)
```
```
 Output only. The resource name of flows referenced by the current playbook
 in the instructions.
 
```
    repeated string referenced_flows = 12 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
    Specified by:
    
    getReferencedFlows in interface PlaybookOrBuilder
    
    Parameters:
    
    index - The index of the element to return.
    
    Returns:
    
    The referencedFlows at the given index.
  - getReferencedFlowsBytes
```
public com.google.protobuf.ByteString getReferencedFlowsBytes(int index)
```
```
 Output only. The resource name of flows referenced by the current playbook
 in the instructions.
 
```
    repeated string referenced_flows = 12 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
    Specified by:
    
    getReferencedFlowsBytes in interface PlaybookOrBuilder
    
    Parameters:
    
    index - The index of the value to return.
    
    Returns:
    
    The bytes of the referencedFlows at the given index.
  - getReferencedToolsList
```
public com.google.protobuf.ProtocolStringList getReferencedToolsList()
```
```
 Optional. The resource name of tools referenced by the current playbook in
 the instructions. If not provided explicitly, they are will
 be implied using the tool being referenced in goal and steps.
 
```
    repeated string referenced_tools = 13 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
    Specified by:
    
    getReferencedToolsList in interface PlaybookOrBuilder
    
    Returns:
    
    A list containing the referencedTools.
  - getReferencedToolsCount
```
public int getReferencedToolsCount()
```
```
 Optional. The resource name of tools referenced by the current playbook in
 the instructions. If not provided explicitly, they are will
 be implied using the tool being referenced in goal and steps.
 
```
    repeated string referenced_tools = 13 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
    Specified by:
    
    getReferencedToolsCount in interface PlaybookOrBuilder
    
    Returns:
    
    The count of referencedTools.
  - getReferencedTools
```
public String getReferencedTools(int index)
```
```
 Optional. The resource name of tools referenced by the current playbook in
 the instructions. If not provided explicitly, they are will
 be implied using the tool being referenced in goal and steps.
 
```
    repeated string referenced_tools = 13 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
    Specified by:
    
    getReferencedTools in interface PlaybookOrBuilder
    
    Parameters:
    
    index - The index of the element to return.
    
    Returns:
    
    The referencedTools at the given index.
  - getReferencedToolsBytes
```
public com.google.protobuf.ByteString getReferencedToolsBytes(int index)
```
```
 Optional. The resource name of tools referenced by the current playbook in
 the instructions. If not provided explicitly, they are will
 be implied using the tool being referenced in goal and steps.
 
```
    repeated string referenced_tools = 13 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
    Specified by:
    
    getReferencedToolsBytes in interface PlaybookOrBuilder
    
    Parameters:
    
    index - The index of the value to return.
    
    Returns:
    
    The bytes of the referencedTools at the given index.
  - hasLlmModelSettings
```
public boolean hasLlmModelSettings()
```
```
 Optional. Llm model settings for the playbook.
 
```
    .google.cloud.dialogflow.cx.v3beta1.LlmModelSettings llm_model_settings = 14 [(.google.api.field_behavior) = OPTIONAL];
    Specified by:
    
    hasLlmModelSettings in interface PlaybookOrBuilder
    
    Returns:
    
    Whether the llmModelSettings field is set.
  - getLlmModelSettings
```
public LlmModelSettings getLlmModelSettings()
```
```
 Optional. Llm model settings for the playbook.
 
```
    .google.cloud.dialogflow.cx.v3beta1.LlmModelSettings llm_model_settings = 14 [(.google.api.field_behavior) = OPTIONAL];
    Specified by:
    
    getLlmModelSettings in interface PlaybookOrBuilder
    
    Returns:
    
    The llmModelSettings.
  - getLlmModelSettingsOrBuilder
```
public LlmModelSettingsOrBuilder getLlmModelSettingsOrBuilder()
```
```
 Optional. Llm model settings for the playbook.
 
```
    .google.cloud.dialogflow.cx.v3beta1.LlmModelSettings llm_model_settings = 14 [(.google.api.field_behavior) = OPTIONAL];
    Specified by:
    
    getLlmModelSettingsOrBuilder in interface PlaybookOrBuilder
  - hasSpeechSettings
```
public boolean hasSpeechSettings()
```
```
 Optional. Playbook level Settings for speech to text detection.
 
```
    .google.cloud.dialogflow.cx.v3beta1.AdvancedSettings.SpeechSettings speech_settings = 20 [(.google.api.field_behavior) = OPTIONAL];
    Specified by:
    
    hasSpeechSettings in interface PlaybookOrBuilder
    
    Returns:
    
    Whether the speechSettings field is set.
  - getSpeechSettings
```
public AdvancedSettings.SpeechSettings getSpeechSettings()
```
```
 Optional. Playbook level Settings for speech to text detection.
 
```
    .google.cloud.dialogflow.cx.v3beta1.AdvancedSettings.SpeechSettings speech_settings = 20 [(.google.api.field_behavior) = OPTIONAL];
    Specified by:
    
    getSpeechSettings in interface PlaybookOrBuilder
    
    Returns:
    
    The speechSettings.
  - getSpeechSettingsOrBuilder
```
public AdvancedSettings.SpeechSettingsOrBuilder getSpeechSettingsOrBuilder()
```
```
 Optional. Playbook level Settings for speech to text detection.
 
```
    .google.cloud.dialogflow.cx.v3beta1.AdvancedSettings.SpeechSettings speech_settings = 20 [(.google.api.field_behavior) = OPTIONAL];
    Specified by:
    
    getSpeechSettingsOrBuilder in interface PlaybookOrBuilder
  - getHandlersList
```
public List<Handler> getHandlersList()
```
```
 Optional. A list of registered handlers to execute based on the specified
 triggers.
 
```
    repeated .google.cloud.dialogflow.cx.v3beta1.Handler handlers = 16 [(.google.api.field_behavior) = OPTIONAL];
    Specified by:
    
    getHandlersList in interface PlaybookOrBuilder
  - getHandlersOrBuilderList
```
public List<? extends HandlerOrBuilder> getHandlersOrBuilderList()
```
```
 Optional. A list of registered handlers to execute based on the specified
 triggers.
 
```
    repeated .google.cloud.dialogflow.cx.v3beta1.Handler handlers = 16 [(.google.api.field_behavior) = OPTIONAL];
    Specified by:
    
    getHandlersOrBuilderList in interface PlaybookOrBuilder
  - getHandlersCount
```
public int getHandlersCount()
```
```
 Optional. A list of registered handlers to execute based on the specified
 triggers.
 
```
    repeated .google.cloud.dialogflow.cx.v3beta1.Handler handlers = 16 [(.google.api.field_behavior) = OPTIONAL];
    Specified by:
    
    getHandlersCount in interface PlaybookOrBuilder
  - getHandlers
```
public Handler getHandlers(int index)
```
```
 Optional. A list of registered handlers to execute based on the specified
 triggers.
 
```
    repeated .google.cloud.dialogflow.cx.v3beta1.Handler handlers = 16 [(.google.api.field_behavior) = OPTIONAL];
    Specified by:
    
    getHandlers in interface PlaybookOrBuilder
  - getHandlersOrBuilder
```
public HandlerOrBuilder getHandlersOrBuilder(int index)
```
```
 Optional. A list of registered handlers to execute based on the specified
 triggers.
 
```
    repeated .google.cloud.dialogflow.cx.v3beta1.Handler handlers = 16 [(.google.api.field_behavior) = OPTIONAL];
    Specified by:
    
    getHandlersOrBuilder in interface PlaybookOrBuilder
  - isInitialized
```
public final boolean isInitialized()
```
    Specified by:
    
    isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class com.google.protobuf.GeneratedMessageV3
  - writeTo
```
public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException
```
    Specified by:
    
    writeTo in interface com.google.protobuf.MessageLite
    
    Overrides:
    
    writeTo in class com.google.protobuf.GeneratedMessageV3
    
    Throws:
    
    IOException
  - getSerializedSize
```
public int getSerializedSize()
```
    Specified by:
    
    getSerializedSize in interface com.google.protobuf.MessageLite
    
    Overrides:
    
    getSerializedSize in class com.google.protobuf.GeneratedMessageV3
  - equals
```
public boolean equals(Object obj)
```
    Specified by:
    
    equals in interface com.google.protobuf.Message
    
    Overrides:
    
    equals in class com.google.protobuf.AbstractMessage
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface com.google.protobuf.Message
    
    Overrides:
    
    hashCode in class com.google.protobuf.AbstractMessage
  - parseFrom
```
public static Playbook parseFrom(ByteBuffer data)
                          throws com.google.protobuf.InvalidProtocolBufferException
```
    Throws:
    
    com.google.protobuf.InvalidProtocolBufferException
  - parseFrom
```
public static Playbook parseFrom(ByteBuffer data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException
```
    Throws:
    
    com.google.protobuf.InvalidProtocolBufferException
  - parseFrom
```
public static Playbook parseFrom(com.google.protobuf.ByteString data)
                          throws com.google.protobuf.InvalidProtocolBufferException
```
    Throws:
    
    com.google.protobuf.InvalidProtocolBufferException
  - parseFrom
```
public static Playbook parseFrom(com.google.protobuf.ByteString data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException
```
    Throws:
    
    com.google.protobuf.InvalidProtocolBufferException
  - parseFrom
```
public static Playbook parseFrom(byte[] data)
                          throws com.google.protobuf.InvalidProtocolBufferException
```
    Throws:
    
    com.google.protobuf.InvalidProtocolBufferException
  - parseFrom
```
public static Playbook parseFrom(byte[] data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException
```
    Throws:
    
    com.google.protobuf.InvalidProtocolBufferException
  - parseFrom
```
public static Playbook parseFrom(InputStream input)
                          throws IOException
```
    Throws:
    
    IOException
  - parseFrom
```
public static Playbook parseFrom(InputStream input,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws IOException
```
    Throws:
    
    IOException
  - parseDelimitedFrom
```
public static Playbook parseDelimitedFrom(InputStream input)
                                   throws IOException
```
    Throws:
    
    IOException
  - parseDelimitedFrom
```
public static Playbook parseDelimitedFrom(InputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws IOException
```
    Throws:
    
    IOException
  - parseFrom
```
public static Playbook parseFrom(com.google.protobuf.CodedInputStream input)
                          throws IOException
```
    Throws:
    
    IOException
  - parseFrom
```
public static Playbook parseFrom(com.google.protobuf.CodedInputStream input,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws IOException
```
    Throws:
    
    IOException
  - newBuilderForType
```
public Playbook.Builder newBuilderForType()
```
    Specified by:
    
    newBuilderForType in interface com.google.protobuf.Message
    
    Specified by:
    
    newBuilderForType in interface com.google.protobuf.MessageLite
  - newBuilder
```
public static Playbook.Builder newBuilder()
```
  - newBuilder
```
public static Playbook.Builder newBuilder(Playbook prototype)
```
  - toBuilder
```
public Playbook.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface com.google.protobuf.Message
    
    Specified by:
    
    toBuilder in interface com.google.protobuf.MessageLite
  - newBuilderForType
```
protected Playbook.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
```
    Specified by:
    
    newBuilderForType in class com.google.protobuf.GeneratedMessageV3
  - getDefaultInstance
```
public static Playbook getDefaultInstance()
```
  - parser
```
public static com.google.protobuf.Parser<Playbook> parser()
```
  - getParserForType
```
public com.google.protobuf.Parser<Playbook> getParserForType()
```
    Specified by:
    
    getParserForType in interface com.google.protobuf.Message
    
    Specified by:
    
    getParserForType in interface com.google.protobuf.MessageLite
    
    Overrides:
    
    getParserForType in class com.google.protobuf.GeneratedMessageV3
  - getDefaultInstanceForType
```
public Playbook getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

Class Playbook

Nested Class Summary

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

Field Summary

Fields inherited from class com.google.protobuf.GeneratedMessageV3

Fields inherited from class com.google.protobuf.AbstractMessage

Fields inherited from class com.google.protobuf.AbstractMessageLite

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessageV3

Methods inherited from class com.google.protobuf.AbstractMessage

Methods inherited from class com.google.protobuf.AbstractMessageLite

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.MessageLite

Field Detail

NAME_FIELD_NUMBER

DISPLAY_NAME_FIELD_NUMBER

GOAL_FIELD_NUMBER

INPUT_PARAMETER_DEFINITIONS_FIELD_NUMBER

OUTPUT_PARAMETER_DEFINITIONS_FIELD_NUMBER

INSTRUCTION_FIELD_NUMBER

TOKEN_COUNT_FIELD_NUMBER

CREATE_TIME_FIELD_NUMBER

UPDATE_TIME_FIELD_NUMBER

REFERENCED_PLAYBOOKS_FIELD_NUMBER

REFERENCED_FLOWS_FIELD_NUMBER

REFERENCED_TOOLS_FIELD_NUMBER

LLM_MODEL_SETTINGS_FIELD_NUMBER

SPEECH_SETTINGS_FIELD_NUMBER

HANDLERS_FIELD_NUMBER

Method Detail

newInstance

getDescriptor

internalGetFieldAccessorTable

getName

getNameBytes

getDisplayName

getDisplayNameBytes

getGoal

getGoalBytes

getInputParameterDefinitionsList

getInputParameterDefinitionsOrBuilderList

getInputParameterDefinitionsCount

getInputParameterDefinitions

getInputParameterDefinitionsOrBuilder

getOutputParameterDefinitionsList

getOutputParameterDefinitionsOrBuilderList

getOutputParameterDefinitionsCount

getOutputParameterDefinitions

getOutputParameterDefinitionsOrBuilder

hasInstruction

getInstruction

getInstructionOrBuilder

getTokenCount

hasCreateTime

getCreateTime

getCreateTimeOrBuilder

hasUpdateTime

getUpdateTime

getUpdateTimeOrBuilder

getReferencedPlaybooksList

getReferencedPlaybooksCount

getReferencedPlaybooks

getReferencedPlaybooksBytes

getReferencedFlowsList

getReferencedFlowsCount

getReferencedFlows

getReferencedFlowsBytes

getReferencedToolsList

getReferencedToolsCount

getReferencedTools

getReferencedToolsBytes

hasLlmModelSettings

getLlmModelSettings

getLlmModelSettingsOrBuilder

hasSpeechSettings

getSpeechSettings

getSpeechSettingsOrBuilder

getHandlersList