Interface PlaybookOrBuilder (0.52.0)

Version 0.52.0

• 0.64.0 (latest)
• 0.63.0
• 0.62.0
• 0.60.0
• 0.59.0
• 0.58.0
• 0.57.0
• 0.56.0
• 0.55.0
• 0.54.0
• 0.53.0
• 0.52.0
• 0.51.0
• 0.50.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.7
• 0.13.1
• 0.12.1
• 0.11.5

public interface PlaybookOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. The timestamp of initial playbook creation.

.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Timestamp	The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The timestamp of initial playbook creation.

.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TimestampOrBuilder

getDisplayName()

public abstract String getDisplayName()

Required. The human-readable name of the playbook, unique within an agent.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

Required. The human-readable name of the playbook, unique within an agent.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for displayName.

getGoal()

public abstract String getGoal()

Required. High level description of the goal the playbook intend to accomplish.

string goal = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The goal.

getGoalBytes()

public abstract ByteString getGoalBytes()

Required. High level description of the goal the playbook intend to accomplish.

string goal = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for goal.

getInputParameterDefinitions(int index)

public abstract 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];

Parameter
Name	Description
index	int

Returns
Type	Description
ParameterDefinition

getInputParameterDefinitionsCount()

public abstract 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];

Returns
Type	Description
int

getInputParameterDefinitionsList()

public abstract 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];

Returns
Type	Description
List<ParameterDefinition>

getInputParameterDefinitionsOrBuilder(int index)

public abstract 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];

Parameter
Name	Description
index	int

Returns
Type	Description
ParameterDefinitionOrBuilder

getInputParameterDefinitionsOrBuilderList()

public abstract 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];

Returns
Type	Description
List<? extends com.google.cloud.dialogflow.cx.v3beta1.ParameterDefinitionOrBuilder>

getLlmModelSettings()

public abstract 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
Type	Description
LlmModelSettings	The llmModelSettings.

getLlmModelSettingsOrBuilder()

public abstract LlmModelSettingsOrBuilder getLlmModelSettingsOrBuilder()

Optional. Llm model settings for the playbook.

.google.cloud.dialogflow.cx.v3beta1.LlmModelSettings llm_model_settings = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
LlmModelSettingsOrBuilder

getName()

public abstract String getName()

The unique identifier of the playbook. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/playbooks/<Playbook ID>.

string name = 1;

Returns
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

The unique identifier of the playbook. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/playbooks/<Playbook ID>.

string name = 1;

Returns
Type	Description
ByteString	The bytes for name.

getOutputParameterDefinitions(int index)

public abstract 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];

Parameter
Name	Description
index	int

Returns
Type	Description
ParameterDefinition

getOutputParameterDefinitionsCount()

public abstract 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];

Returns
Type	Description
int

getOutputParameterDefinitionsList()

public abstract 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];

Returns
Type	Description
List<ParameterDefinition>

getOutputParameterDefinitionsOrBuilder(int index)

public abstract 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];

Parameter
Name	Description
index	int

Returns
Type	Description
ParameterDefinitionOrBuilder

getOutputParameterDefinitionsOrBuilderList()

public abstract 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];

Returns
Type	Description
List<? extends com.google.cloud.dialogflow.cx.v3beta1.ParameterDefinitionOrBuilder>

getReferencedFlows(int index)

public abstract 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) = { ... }

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The referencedFlows at the given index.

getReferencedFlowsBytes(int index)

public abstract 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) = { ... }

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the referencedFlows at the given index.

getReferencedFlowsCount()

public abstract 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
Type	Description
int	The count of referencedFlows.

getReferencedFlowsList()

public abstract 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
Type	Description
List<String>	A list containing the referencedFlows.

getReferencedPlaybooks(int index)

public abstract 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) = { ... }

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The referencedPlaybooks at the given index.

getReferencedPlaybooksBytes(int index)

public abstract 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) = { ... }

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the referencedPlaybooks at the given index.

getReferencedPlaybooksCount()

public abstract 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
Type	Description
int	The count of referencedPlaybooks.

getReferencedPlaybooksList()

public abstract 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
Type	Description
List<String>	A list containing the referencedPlaybooks.

getReferencedTools(int index)

public abstract 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) = { ... }

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The referencedTools at the given index.

getReferencedToolsBytes(int index)

public abstract 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) = { ... }

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the referencedTools at the given index.

getReferencedToolsCount()

public abstract 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
Type	Description
int	The count of referencedTools.

getReferencedToolsList()

public abstract 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
Type	Description
List<String>	A list containing the referencedTools.

getSteps(int index)

public abstract Playbook.Step getSteps(int index)

Ordered list of step by step execution instructions to accomplish target goal.

repeated .google.cloud.dialogflow.cx.v3beta1.Playbook.Step steps = 4;

Parameter
Name	Description
index	int

Returns
Type	Description
Playbook.Step

getStepsCount()

public abstract int getStepsCount()

Ordered list of step by step execution instructions to accomplish target goal.

repeated .google.cloud.dialogflow.cx.v3beta1.Playbook.Step steps = 4;

Returns
Type	Description
int

getStepsList()

public abstract List<Playbook.Step> getStepsList()

Ordered list of step by step execution instructions to accomplish target goal.

repeated .google.cloud.dialogflow.cx.v3beta1.Playbook.Step steps = 4;

Returns
Type	Description
List<Step>

getStepsOrBuilder(int index)

public abstract Playbook.StepOrBuilder getStepsOrBuilder(int index)

Ordered list of step by step execution instructions to accomplish target goal.

repeated .google.cloud.dialogflow.cx.v3beta1.Playbook.Step steps = 4;

Parameter
Name	Description
index	int

Returns
Type	Description
Playbook.StepOrBuilder

getStepsOrBuilderList()

public abstract List<? extends Playbook.StepOrBuilder> getStepsOrBuilderList()

Ordered list of step by step execution instructions to accomplish target goal.

repeated .google.cloud.dialogflow.cx.v3beta1.Playbook.Step steps = 4;

Returns
Type	Description
List<? extends com.google.cloud.dialogflow.cx.v3beta1.Playbook.StepOrBuilder>

getTokenCount()

public abstract 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
Type	Description
long	The tokenCount.

getUpdateTime()

public abstract Timestamp getUpdateTime()

Output only. Last time the playbook version was updated.

.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Timestamp	The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Last time the playbook version was updated.

.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TimestampOrBuilder

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. The timestamp of initial playbook creation.

.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the createTime field is set.

hasLlmModelSettings()

public abstract 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
Type	Description
boolean	Whether the llmModelSettings field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

Output only. Last time the playbook version was updated.

.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the updateTime field is set.