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

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Playbook, Playbook.Builder
```
public interface PlaybookOrBuilder
extends com.google.protobuf.MessageOrBuilder
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`com.google.protobuf.Timestamp`	`getCreateTime()` Output only.
`com.google.protobuf.TimestampOrBuilder`	`getCreateTimeOrBuilder()` Output only.
`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.
`String`	`getReferencedFlows(int index)` Output only.
`com.google.protobuf.ByteString`	`getReferencedFlowsBytes(int index)` Output only.
`int`	`getReferencedFlowsCount()` Output only.
`List<String>`	`getReferencedFlowsList()` Output only.
`String`	`getReferencedPlaybooks(int index)` Output only.
`com.google.protobuf.ByteString`	`getReferencedPlaybooksBytes(int index)` Output only.
`int`	`getReferencedPlaybooksCount()` Output only.
`List<String>`	`getReferencedPlaybooksList()` Output only.
`String`	`getReferencedTools(int index)` Optional.
`com.google.protobuf.ByteString`	`getReferencedToolsBytes(int index)` Optional.
`int`	`getReferencedToolsCount()` Optional.
`List<String>`	`getReferencedToolsList()` Optional.
`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.
`boolean`	`hasInstruction()` Instruction to accomplish target goal.
`boolean`	`hasLlmModelSettings()` Optional.
`boolean`	`hasSpeechSettings()` Optional.
`boolean`	`hasUpdateTime()` Output only.

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitialized

- Method Detail
  - getName
```
String getName()
```
```
 The unique identifier of the playbook.
 Format:
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>`.
 
```
    string name = 1;
    Returns:
    
    The name.
  - getNameBytes
```
com.google.protobuf.ByteString getNameBytes()
```
```
 The unique identifier of the playbook.
 Format:
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>`.
 
```
    string name = 1;
    Returns:
    
    The bytes for name.
  - getDisplayName
```
String getDisplayName()
```
```
 Required. The human-readable name of the playbook, unique within an agent.
 
```
    string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
    Returns:
    
    The displayName.
  - getDisplayNameBytes
```
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];
    Returns:
    
    The bytes for displayName.
  - getGoal
```
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];
    Returns:
    
    The goal.
  - getGoalBytes
```
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];
    Returns:
    
    The bytes for goal.
  - getInputParameterDefinitionsList
```
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];
  - getInputParameterDefinitions
```
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];
  - getInputParameterDefinitionsCount
```
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];
  - getInputParameterDefinitionsOrBuilderList
```
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];
  - getInputParameterDefinitionsOrBuilder
```
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];
  - getOutputParameterDefinitionsList
```
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];
  - getOutputParameterDefinitions
```
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];
  - getOutputParameterDefinitionsCount
```
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];
  - getOutputParameterDefinitionsOrBuilderList
```
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];
  - getOutputParameterDefinitionsOrBuilder
```
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];
  - hasInstruction
```
boolean hasInstruction()
```
```
 Instruction to accomplish target goal.
 
```
    .google.cloud.dialogflow.cx.v3beta1.Playbook.Instruction instruction = 17;
    Returns:
    
    Whether the instruction field is set.
  - getInstruction
```
Playbook.Instruction getInstruction()
```
```
 Instruction to accomplish target goal.
 
```
    .google.cloud.dialogflow.cx.v3beta1.Playbook.Instruction instruction = 17;
    Returns:
    
    The instruction.
  - getInstructionOrBuilder
```
Playbook.InstructionOrBuilder getInstructionOrBuilder()
```
```
 Instruction to accomplish target goal.
 
```
    .google.cloud.dialogflow.cx.v3beta1.Playbook.Instruction instruction = 17;
  - getTokenCount
```
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];
    Returns:
    
    The tokenCount.
  - hasCreateTime
```
boolean hasCreateTime()
```
```
 Output only. The timestamp of initial playbook creation.
 
```
    .google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Returns:
    
    Whether the createTime field is set.
  - getCreateTime
```
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];
    Returns:
    
    The createTime.
  - getCreateTimeOrBuilder
```
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];
  - hasUpdateTime
```
boolean hasUpdateTime()
```
```
 Output only. Last time the playbook version was updated.
 
```
    .google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Returns:
    
    Whether the updateTime field is set.
  - getUpdateTime
```
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];
    Returns:
    
    The updateTime.
  - getUpdateTimeOrBuilder
```
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];
  - getReferencedPlaybooksList
```
List<String> 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) = { ... }
    Returns:
    
    A list containing the referencedPlaybooks.
  - getReferencedPlaybooksCount
```
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) = { ... }
    Returns:
    
    The count of referencedPlaybooks.
  - getReferencedPlaybooks
```
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) = { ... }
    Parameters:
    
    index - The index of the element to return.
    
    Returns:
    
    The referencedPlaybooks at the given index.
  - getReferencedPlaybooksBytes
```
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) = { ... }
    Parameters:
    
    index - The index of the value to return.
    
    Returns:
    
    The bytes of the referencedPlaybooks at the given index.
  - getReferencedFlowsList
```
List<String> 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) = { ... }
    Returns:
    
    A list containing the referencedFlows.
  - getReferencedFlowsCount
```
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) = { ... }
    Returns:
    
    The count of referencedFlows.
  - getReferencedFlows
```
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) = { ... }
    Parameters:
    
    index - The index of the element to return.
    
    Returns:
    
    The referencedFlows at the given index.
  - getReferencedFlowsBytes
```
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) = { ... }
    Parameters:
    
    index - The index of the value to return.
    
    Returns:
    
    The bytes of the referencedFlows at the given index.
  - getReferencedToolsList
```
List<String> 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) = { ... }
    Returns:
    
    A list containing the referencedTools.
  - getReferencedToolsCount
```
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) = { ... }
    Returns:
    
    The count of referencedTools.
  - getReferencedTools
```
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) = { ... }
    Parameters:
    
    index - The index of the element to return.
    
    Returns:
    
    The referencedTools at the given index.
  - getReferencedToolsBytes
```
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) = { ... }
    Parameters:
    
    index - The index of the value to return.
    
    Returns:
    
    The bytes of the referencedTools at the given index.
  - hasLlmModelSettings
```
boolean hasLlmModelSettings()
```
```
 Optional. Llm model settings for the playbook.
 
```
    .google.cloud.dialogflow.cx.v3beta1.LlmModelSettings llm_model_settings = 14 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    Whether the llmModelSettings field is set.
  - getLlmModelSettings
```
LlmModelSettings getLlmModelSettings()
```
```
 Optional. Llm model settings for the playbook.
 
```
    .google.cloud.dialogflow.cx.v3beta1.LlmModelSettings llm_model_settings = 14 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    The llmModelSettings.
  - getLlmModelSettingsOrBuilder
```
LlmModelSettingsOrBuilder getLlmModelSettingsOrBuilder()
```
```
 Optional. Llm model settings for the playbook.
 
```
    .google.cloud.dialogflow.cx.v3beta1.LlmModelSettings llm_model_settings = 14 [(.google.api.field_behavior) = OPTIONAL];
  - hasSpeechSettings
```
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];
    Returns:
    
    Whether the speechSettings field is set.
  - getSpeechSettings
```
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];
    Returns:
    
    The speechSettings.
  - getSpeechSettingsOrBuilder
```
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];
  - getHandlersList
```
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];
  - getHandlers
```
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];
  - getHandlersCount
```
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];
  - getHandlersOrBuilderList
```
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];
  - getHandlersOrBuilder
```
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];

Interface PlaybookOrBuilder

Method Summary

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

Method Detail

getName

getNameBytes

getDisplayName

getDisplayNameBytes

getGoal

getGoalBytes

getInputParameterDefinitionsList

getInputParameterDefinitions

getInputParameterDefinitionsCount

getInputParameterDefinitionsOrBuilderList

getInputParameterDefinitionsOrBuilder

getOutputParameterDefinitionsList

getOutputParameterDefinitions

getOutputParameterDefinitionsCount

getOutputParameterDefinitionsOrBuilderList

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

getHandlers

getHandlersCount

getHandlersOrBuilderList

getHandlersOrBuilder