public final class Tool extends GeneratedMessageV3 implements ToolOrBuilder
Represents a tool.
Protobuf type google.cloud.dialogflow.v2.Tool
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int ACTION_CONFIRMATION_REQUIREMENT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int CONNECTOR_SPEC_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int DISPLAY_NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int EXTENSION_SPEC_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int FUNCTION_SPEC_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int OPEN_API_SPEC_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int SATISFIES_PZI_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int SATISFIES_PZS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int TOOL_KEY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
public static Tool getDefaultInstance()
| Returns |
| Type |
Description |
Tool |
|
public static final Descriptors.Descriptor getDescriptor()
public static Tool.Builder newBuilder()
public static Tool.Builder newBuilder(Tool prototype)
| Parameter |
| Name |
Description |
prototype |
Tool
|
public static Tool parseDelimitedFrom(InputStream input)
| Returns |
| Type |
Description |
Tool |
|
public static Tool parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Tool |
|
public static Tool parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
| Returns |
| Type |
Description |
Tool |
|
public static Tool parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Tool |
|
public static Tool parseFrom(ByteString data)
| Returns |
| Type |
Description |
Tool |
|
public static Tool parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Tool |
|
public static Tool parseFrom(CodedInputStream input)
| Returns |
| Type |
Description |
Tool |
|
public static Tool parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Tool |
|
public static Tool parseFrom(InputStream input)
| Returns |
| Type |
Description |
Tool |
|
public static Tool parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Tool |
|
public static Tool parseFrom(ByteBuffer data)
| Returns |
| Type |
Description |
Tool |
|
public static Tool parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Tool |
|
public static Parser<Tool> parser()
Methods
public boolean containsActionConfirmationRequirement(String key)
Optional. Confirmation requirement for the actions. Each key is an action
name in the action_schemas. If an action's confirmation requirement is
unspecified (either the key is not present, or its value is
CONFIRMATION_REQUIREMENT_UNSPECIFIED), the requirement is inferred from the
action's method_type - confirmation is not required if and only if
method_type is GET.
map<string, .google.cloud.dialogflow.v2.Tool.ConfirmationRequirement> action_confirmation_requirement = 17 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
key |
String
|
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
public Map<String,Tool.ConfirmationRequirement> getActionConfirmationRequirement()
public int getActionConfirmationRequirementCount()
Optional. Confirmation requirement for the actions. Each key is an action
name in the action_schemas. If an action's confirmation requirement is
unspecified (either the key is not present, or its value is
CONFIRMATION_REQUIREMENT_UNSPECIFIED), the requirement is inferred from the
action's method_type - confirmation is not required if and only if
method_type is GET.
map<string, .google.cloud.dialogflow.v2.Tool.ConfirmationRequirement> action_confirmation_requirement = 17 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
|
public Map<String,Tool.ConfirmationRequirement> getActionConfirmationRequirementMap()
Optional. Confirmation requirement for the actions. Each key is an action
name in the action_schemas. If an action's confirmation requirement is
unspecified (either the key is not present, or its value is
CONFIRMATION_REQUIREMENT_UNSPECIFIED), the requirement is inferred from the
action's method_type - confirmation is not required if and only if
method_type is GET.
map<string, .google.cloud.dialogflow.v2.Tool.ConfirmationRequirement> action_confirmation_requirement = 17 [(.google.api.field_behavior) = OPTIONAL];
public Tool.ConfirmationRequirement getActionConfirmationRequirementOrDefault(String key, Tool.ConfirmationRequirement defaultValue)
Optional. Confirmation requirement for the actions. Each key is an action
name in the action_schemas. If an action's confirmation requirement is
unspecified (either the key is not present, or its value is
CONFIRMATION_REQUIREMENT_UNSPECIFIED), the requirement is inferred from the
action's method_type - confirmation is not required if and only if
method_type is GET.
map<string, .google.cloud.dialogflow.v2.Tool.ConfirmationRequirement> action_confirmation_requirement = 17 [(.google.api.field_behavior) = OPTIONAL];
public Tool.ConfirmationRequirement getActionConfirmationRequirementOrThrow(String key)
Optional. Confirmation requirement for the actions. Each key is an action
name in the action_schemas. If an action's confirmation requirement is
unspecified (either the key is not present, or its value is
CONFIRMATION_REQUIREMENT_UNSPECIFIED), the requirement is inferred from the
action's method_type - confirmation is not required if and only if
method_type is GET.
map<string, .google.cloud.dialogflow.v2.Tool.ConfirmationRequirement> action_confirmation_requirement = 17 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
key |
String
|
public Map<String,Integer> getActionConfirmationRequirementValue()
public Map<String,Integer> getActionConfirmationRequirementValueMap()
Optional. Confirmation requirement for the actions. Each key is an action
name in the action_schemas. If an action's confirmation requirement is
unspecified (either the key is not present, or its value is
CONFIRMATION_REQUIREMENT_UNSPECIFIED), the requirement is inferred from the
action's method_type - confirmation is not required if and only if
method_type is GET.
map<string, .google.cloud.dialogflow.v2.Tool.ConfirmationRequirement> action_confirmation_requirement = 17 [(.google.api.field_behavior) = OPTIONAL];
public int getActionConfirmationRequirementValueOrDefault(String key, int defaultValue)
Optional. Confirmation requirement for the actions. Each key is an action
name in the action_schemas. If an action's confirmation requirement is
unspecified (either the key is not present, or its value is
CONFIRMATION_REQUIREMENT_UNSPECIFIED), the requirement is inferred from the
action's method_type - confirmation is not required if and only if
method_type is GET.
map<string, .google.cloud.dialogflow.v2.Tool.ConfirmationRequirement> action_confirmation_requirement = 17 [(.google.api.field_behavior) = OPTIONAL];
| Parameters |
| Name |
Description |
key |
String
|
defaultValue |
int
|
| Returns |
| Type |
Description |
int |
|
public int getActionConfirmationRequirementValueOrThrow(String key)
Optional. Confirmation requirement for the actions. Each key is an action
name in the action_schemas. If an action's confirmation requirement is
unspecified (either the key is not present, or its value is
CONFIRMATION_REQUIREMENT_UNSPECIFIED), the requirement is inferred from the
action's method_type - confirmation is not required if and only if
method_type is GET.
map<string, .google.cloud.dialogflow.v2.Tool.ConfirmationRequirement> action_confirmation_requirement = 17 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
key |
String
|
| Returns |
| Type |
Description |
int |
|
public Tool.ConnectorTool getConnectorSpec()
Integration connectors tool specification.
.google.cloud.dialogflow.v2.Tool.ConnectorTool connector_spec = 18;
public Tool.ConnectorToolOrBuilder getConnectorSpecOrBuilder()
Integration connectors tool specification.
.google.cloud.dialogflow.v2.Tool.ConnectorTool connector_spec = 18;
public Timestamp getCreateTime()
Output only. Creation time of this tool.
.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
Timestamp |
The createTime.
|
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Creation time of this tool.
.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Tool getDefaultInstanceForType()
| Returns |
| Type |
Description |
Tool |
|
public String getDescription()
Optional. A human readable description of the tool.
string description = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
The description.
|
public ByteString getDescriptionBytes()
Optional. A human readable description of the tool.
string description = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
ByteString |
The bytes for description.
|
public String getDisplayName()
Optional. A human readable short name of the tool, to be shown on the UI.
string display_name = 19 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
The displayName.
|
public ByteString getDisplayNameBytes()
Optional. A human readable short name of the tool, to be shown on the UI.
string display_name = 19 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
ByteString |
The bytes for displayName.
|
getExtensionSpec() (deprecated)
public Tool.ExtensionTool getExtensionSpec()
Deprecated. google.cloud.dialogflow.v2.Tool.extension_spec is deprecated. See
google/cloud/dialogflow/v2/tool.proto;l=563
Vertex extension tool specification.
.google.cloud.dialogflow.v2.Tool.ExtensionTool extension_spec = 4 [deprecated = true];
getExtensionSpecOrBuilder() (deprecated)
public Tool.ExtensionToolOrBuilder getExtensionSpecOrBuilder()
Vertex extension tool specification.
.google.cloud.dialogflow.v2.Tool.ExtensionTool extension_spec = 4 [deprecated = true];
public Tool.FunctionTool getFunctionSpec()
Client side executed function specification.
.google.cloud.dialogflow.v2.Tool.FunctionTool function_spec = 13;
public Tool.FunctionToolOrBuilder getFunctionSpecOrBuilder()
Client side executed function specification.
.google.cloud.dialogflow.v2.Tool.FunctionTool function_spec = 13;
Output only. Identifier. The resource name of the tool. Format:
projects/<Project ID>/locations/<Location ID>/tools/<Tool ID>.
string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
String |
The name.
|
public ByteString getNameBytes()
Output only. Identifier. The resource name of the tool. Format:
projects/<Project ID>/locations/<Location ID>/tools/<Tool ID>.
string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
ByteString |
The bytes for name.
|
public Tool.OpenApiTool getOpenApiSpec()
OpenAPI tool.
.google.cloud.dialogflow.v2.Tool.OpenApiTool open_api_spec = 20;
public Tool.OpenApiToolOrBuilder getOpenApiSpecOrBuilder()
OpenAPI tool.
.google.cloud.dialogflow.v2.Tool.OpenApiTool open_api_spec = 20;
public Parser<Tool> getParserForType()
Overrides
public boolean getSatisfiesPzi()
Output only. A read only boolean field reflecting Zone Isolation status
of the tool. If the field is absent, it means the status is unknown.
optional bool satisfies_pzi = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
The satisfiesPzi.
|
public boolean getSatisfiesPzs()
Output only. A read only boolean field reflecting Zone Separation
status of the tool. If the field is absent, it means the status is unknown.
optional bool satisfies_pzs = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
The satisfiesPzs.
|
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
public Tool.SpecificationCase getSpecificationCase()
public String getToolKey()
Required. A human readable short name of the tool, which should be unique
within the project. It should only contain letters, numbers, and
underscores, and it will be used by LLM to identify the tool.
string tool_key = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
String |
The toolKey.
|
public ByteString getToolKeyBytes()
Required. A human readable short name of the tool, which should be unique
within the project. It should only contain letters, numbers, and
underscores, and it will be used by LLM to identify the tool.
string tool_key = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
ByteString |
The bytes for toolKey.
|
public Timestamp getUpdateTime()
Output only. Update time of this tool.
.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
Timestamp |
The updateTime.
|
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. Update time of this tool.
.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
public boolean hasConnectorSpec()
Integration connectors tool specification.
.google.cloud.dialogflow.v2.Tool.ConnectorTool connector_spec = 18;
| Returns |
| Type |
Description |
boolean |
Whether the connectorSpec field is set.
|
public boolean hasCreateTime()
Output only. Creation time of this tool.
.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
Whether the createTime field is set.
|
public boolean hasExtensionSpec()
Deprecated. google.cloud.dialogflow.v2.Tool.extension_spec is deprecated. See
google/cloud/dialogflow/v2/tool.proto;l=563
Vertex extension tool specification.
.google.cloud.dialogflow.v2.Tool.ExtensionTool extension_spec = 4 [deprecated = true];
| Returns |
| Type |
Description |
boolean |
Whether the extensionSpec field is set.
|
public boolean hasFunctionSpec()
Client side executed function specification.
.google.cloud.dialogflow.v2.Tool.FunctionTool function_spec = 13;
| Returns |
| Type |
Description |
boolean |
Whether the functionSpec field is set.
|
public boolean hasOpenApiSpec()
OpenAPI tool.
.google.cloud.dialogflow.v2.Tool.OpenApiTool open_api_spec = 20;
| Returns |
| Type |
Description |
boolean |
Whether the openApiSpec field is set.
|
public boolean hasSatisfiesPzi()
Output only. A read only boolean field reflecting Zone Isolation status
of the tool. If the field is absent, it means the status is unknown.
optional bool satisfies_pzi = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
Whether the satisfiesPzi field is set.
|
public boolean hasSatisfiesPzs()
Output only. A read only boolean field reflecting Zone Separation
status of the tool. If the field is absent, it means the status is unknown.
optional bool satisfies_pzs = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
Whether the satisfiesPzs field is set.
|
public boolean hasUpdateTime()
Output only. Update time of this tool.
.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
Whether the updateTime field is set.
|
| Returns |
| Type |
Description |
int |
|
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
| Parameter |
| Name |
Description |
number |
int
|
| Returns |
| Type |
Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
public final boolean isInitialized()
Overrides
public Tool.Builder newBuilderForType()
protected Tool.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
public Tool.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
