Class Agent.Builder (0.14.1)

Version 0.14.1

• 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 static final class Agent.Builder extends GeneratedMessageV3.Builder<Agent.Builder> implements AgentOrBuilder

Agents are best described as Natural Language Understanding (NLU) modules that transform user requests into actionable data. You can include agents in your app, product, or service to determine user intent and respond to the user in a natural way. After you create an agent, you can add Intents, Entity Types, Flows, Fulfillments, Webhooks, and so on to manage the conversation flows..

Protobuf type google.cloud.dialogflow.cx.v3.Agent

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Agent.Builder

Implements

AgentOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

Methods

addAllSupportedLanguageCodes(Iterable<String> values)

public Agent.Builder addAllSupportedLanguageCodes(Iterable<String> values)

The list of all languages supported by the agent (except for the default_language_code).

repeated string supported_language_codes = 4;

Parameter

Name	Description
values	Iterable<String> The supportedLanguageCodes to add.

Returns

Type	Description
Agent.Builder	This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Agent.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
Agent.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

addSupportedLanguageCodes(String value)

public Agent.Builder addSupportedLanguageCodes(String value)

The list of all languages supported by the agent (except for the default_language_code).

repeated string supported_language_codes = 4;

Parameter

Name	Description
value	String The supportedLanguageCodes to add.

Returns

Type	Description
Agent.Builder	This builder for chaining.

addSupportedLanguageCodesBytes(ByteString value)

public Agent.Builder addSupportedLanguageCodesBytes(ByteString value)

The list of all languages supported by the agent (except for the default_language_code).

repeated string supported_language_codes = 4;

Parameter

Name	Description
value	ByteString The bytes of the supportedLanguageCodes to add.

Returns

Type	Description
Agent.Builder	This builder for chaining.

build()

public Agent build()

Returns

Type	Description
Agent

buildPartial()

public Agent buildPartial()

Returns

Type	Description
Agent

clear()

public Agent.Builder clear()

Returns

Type	Description
Agent.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearAdvancedSettings()

public Agent.Builder clearAdvancedSettings()

Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level.

.google.cloud.dialogflow.cx.v3.AdvancedSettings advanced_settings = 22;

Returns

Type	Description
Agent.Builder

clearAvatarUri()

public Agent.Builder clearAvatarUri()

The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration.

string avatar_uri = 7;

Returns

Type	Description
Agent.Builder	This builder for chaining.

clearDefaultLanguageCode()

public Agent.Builder clearDefaultLanguageCode()

Required. Immutable. The default language of the agent as a language tag. See Language Support for a list of the currently supported language codes. This field cannot be set by the Agents.UpdateAgent method.

string default_language_code = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns

Type	Description
Agent.Builder	This builder for chaining.

clearDescription()

public Agent.Builder clearDescription()

The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected.

string description = 6;

Returns

Type	Description
Agent.Builder	This builder for chaining.

clearDisplayName()

public Agent.Builder clearDisplayName()

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

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

Returns

Type	Description
Agent.Builder	This builder for chaining.

clearEnableSpellCorrection()

public Agent.Builder clearEnableSpellCorrection()

Indicates if automatic spell correction is enabled in detect intent requests.

bool enable_spell_correction = 20;

Returns

Type	Description
Agent.Builder	This builder for chaining.

clearEnableStackdriverLogging() (deprecated)

public Agent.Builder clearEnableStackdriverLogging()

Deprecated. google.cloud.dialogflow.cx.v3.Agent.enable_stackdriver_logging is deprecated. See google/cloud/dialogflow/cx/v3/agent.proto;l=245

Indicates if stackdriver logging is enabled for the agent. Please use agent.advanced_settings instead.

bool enable_stackdriver_logging = 18 [deprecated = true];

Returns

Type	Description
Agent.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Agent.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	FieldDescriptor

Returns

Type	Description
Agent.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearLocked()

public Agent.Builder clearLocked()

Indicates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for [RestoreAgent][].

bool locked = 27;

Returns

Type	Description
Agent.Builder	This builder for chaining.

clearName()

public Agent.Builder clearName()

The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

string name = 1;

Returns

Type	Description
Agent.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Agent.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	OneofDescriptor

Returns

Type	Description
Agent.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearSecuritySettings()

public Agent.Builder clearSecuritySettings()

Name of the SecuritySettings reference for the agent. Format: projects/<Project ID>/locations/<Location ID>/securitySettings/<Security Settings ID>.

string security_settings = 17 [(.google.api.resource_reference) = { ... }

Returns

Type	Description
Agent.Builder	This builder for chaining.

clearSpeechToTextSettings()

public Agent.Builder clearSpeechToTextSettings()

Speech recognition related settings.

.google.cloud.dialogflow.cx.v3.SpeechToTextSettings speech_to_text_settings = 13;

Returns

Type	Description
Agent.Builder

clearStartFlow()

public Agent.Builder clearStartFlow()

Immutable. Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.

string start_flow = 16 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Returns

Type	Description
Agent.Builder	This builder for chaining.

clearSupportedLanguageCodes()

public Agent.Builder clearSupportedLanguageCodes()

The list of all languages supported by the agent (except for the default_language_code).

repeated string supported_language_codes = 4;

Returns

Type	Description
Agent.Builder	This builder for chaining.

clearTimeZone()

public Agent.Builder clearTimeZone()

Required. The time zone of the agent from the time zone database, e.g., America/New_York, Europe/Paris.

string time_zone = 5 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
Agent.Builder	This builder for chaining.

clone()

public Agent.Builder clone()

Returns

Type	Description
Agent.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getAdvancedSettings()

public AdvancedSettings getAdvancedSettings()

Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level.

.google.cloud.dialogflow.cx.v3.AdvancedSettings advanced_settings = 22;

Returns

Type	Description
AdvancedSettings	The advancedSettings.

getAdvancedSettingsBuilder()

public AdvancedSettings.Builder getAdvancedSettingsBuilder()

Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level.

.google.cloud.dialogflow.cx.v3.AdvancedSettings advanced_settings = 22;

Returns

Type	Description
AdvancedSettings.Builder

getAdvancedSettingsOrBuilder()

public AdvancedSettingsOrBuilder getAdvancedSettingsOrBuilder()

Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level.

.google.cloud.dialogflow.cx.v3.AdvancedSettings advanced_settings = 22;

Returns

Type	Description
AdvancedSettingsOrBuilder

getAvatarUri()

public String getAvatarUri()

The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration.

string avatar_uri = 7;

Returns

Type	Description
String	The avatarUri.

getAvatarUriBytes()

public ByteString getAvatarUriBytes()

The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration.

string avatar_uri = 7;

Returns

Type	Description
ByteString	The bytes for avatarUri.

getDefaultInstanceForType()

public Agent getDefaultInstanceForType()

Returns

Type	Description
Agent

getDefaultLanguageCode()

public String getDefaultLanguageCode()

Required. Immutable. The default language of the agent as a language tag. See Language Support for a list of the currently supported language codes. This field cannot be set by the Agents.UpdateAgent method.

string default_language_code = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns

Type	Description
String	The defaultLanguageCode.

getDefaultLanguageCodeBytes()

public ByteString getDefaultLanguageCodeBytes()

Required. Immutable. The default language of the agent as a language tag. See Language Support for a list of the currently supported language codes. This field cannot be set by the Agents.UpdateAgent method.

string default_language_code = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns

Type	Description
ByteString	The bytes for defaultLanguageCode.

getDescription()

public String getDescription()

The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected.

string description = 6;

Returns

Type	Description
String	The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected.

string description = 6;

Returns

Type	Description
ByteString	The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getDisplayName()

public String getDisplayName()

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

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

Returns

Type	Description
String	The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

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

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

Returns

Type	Description
ByteString	The bytes for displayName.

getEnableSpellCorrection()

public boolean getEnableSpellCorrection()

Indicates if automatic spell correction is enabled in detect intent requests.

bool enable_spell_correction = 20;

Returns

Type	Description
boolean	The enableSpellCorrection.

getEnableStackdriverLogging() (deprecated)

public boolean getEnableStackdriverLogging()

Deprecated. google.cloud.dialogflow.cx.v3.Agent.enable_stackdriver_logging is deprecated. See google/cloud/dialogflow/cx/v3/agent.proto;l=245

Indicates if stackdriver logging is enabled for the agent. Please use agent.advanced_settings instead.

bool enable_stackdriver_logging = 18 [deprecated = true];

Returns

Type	Description
boolean	The enableStackdriverLogging.

getLocked()

public boolean getLocked()

Indicates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for [RestoreAgent][].

bool locked = 27;

Returns

Type	Description
boolean	The locked.

getName()

public String getName()

The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

string name = 1;

Returns

Type	Description
String	The name.

getNameBytes()

public ByteString getNameBytes()

The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

string name = 1;

Returns

Type	Description
ByteString	The bytes for name.

getSecuritySettings()

public String getSecuritySettings()

Name of the SecuritySettings reference for the agent. Format: projects/<Project ID>/locations/<Location ID>/securitySettings/<Security Settings ID>.

string security_settings = 17 [(.google.api.resource_reference) = { ... }

Returns

Type	Description
String	The securitySettings.

getSecuritySettingsBytes()

public ByteString getSecuritySettingsBytes()

Name of the SecuritySettings reference for the agent. Format: projects/<Project ID>/locations/<Location ID>/securitySettings/<Security Settings ID>.

string security_settings = 17 [(.google.api.resource_reference) = { ... }

Returns

Type	Description
ByteString	The bytes for securitySettings.

getSpeechToTextSettings()

public SpeechToTextSettings getSpeechToTextSettings()

Speech recognition related settings.

.google.cloud.dialogflow.cx.v3.SpeechToTextSettings speech_to_text_settings = 13;

Returns

Type	Description
SpeechToTextSettings	The speechToTextSettings.

getSpeechToTextSettingsBuilder()

public SpeechToTextSettings.Builder getSpeechToTextSettingsBuilder()

Speech recognition related settings.

.google.cloud.dialogflow.cx.v3.SpeechToTextSettings speech_to_text_settings = 13;

Returns

Type	Description
SpeechToTextSettings.Builder

getSpeechToTextSettingsOrBuilder()

public SpeechToTextSettingsOrBuilder getSpeechToTextSettingsOrBuilder()

Speech recognition related settings.

.google.cloud.dialogflow.cx.v3.SpeechToTextSettings speech_to_text_settings = 13;

Returns

Type	Description
SpeechToTextSettingsOrBuilder

getStartFlow()

public String getStartFlow()

Immutable. Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.

string start_flow = 16 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Returns

Type	Description
String	The startFlow.

getStartFlowBytes()

public ByteString getStartFlowBytes()

Immutable. Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.

string start_flow = 16 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Returns

Type	Description
ByteString	The bytes for startFlow.

getSupportedLanguageCodes(int index)

public String getSupportedLanguageCodes(int index)

The list of all languages supported by the agent (except for the default_language_code).

repeated string supported_language_codes = 4;

Parameter

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

Returns

Type	Description
String	The supportedLanguageCodes at the given index.

getSupportedLanguageCodesBytes(int index)

public ByteString getSupportedLanguageCodesBytes(int index)

The list of all languages supported by the agent (except for the default_language_code).

repeated string supported_language_codes = 4;

Parameter

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

Returns

Type	Description
ByteString	The bytes of the supportedLanguageCodes at the given index.

getSupportedLanguageCodesCount()

public int getSupportedLanguageCodesCount()

The list of all languages supported by the agent (except for the default_language_code).

repeated string supported_language_codes = 4;

Returns

Type	Description
int	The count of supportedLanguageCodes.

getSupportedLanguageCodesList()

public ProtocolStringList getSupportedLanguageCodesList()

The list of all languages supported by the agent (except for the default_language_code).

repeated string supported_language_codes = 4;

Returns

Type	Description
ProtocolStringList	A list containing the supportedLanguageCodes.

getTimeZone()

public String getTimeZone()

Required. The time zone of the agent from the time zone database, e.g., America/New_York, Europe/Paris.

string time_zone = 5 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
String	The timeZone.

getTimeZoneBytes()

public ByteString getTimeZoneBytes()

Required. The time zone of the agent from the time zone database, e.g., America/New_York, Europe/Paris.

string time_zone = 5 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
ByteString	The bytes for timeZone.

hasAdvancedSettings()

public boolean hasAdvancedSettings()

Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level.

.google.cloud.dialogflow.cx.v3.AdvancedSettings advanced_settings = 22;

Returns

Type	Description
boolean	Whether the advancedSettings field is set.

hasSpeechToTextSettings()

public boolean hasSpeechToTextSettings()

Speech recognition related settings.

.google.cloud.dialogflow.cx.v3.SpeechToTextSettings speech_to_text_settings = 13;

Returns

Type	Description
boolean	Whether the speechToTextSettings field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeAdvancedSettings(AdvancedSettings value)

public Agent.Builder mergeAdvancedSettings(AdvancedSettings value)

Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level.

.google.cloud.dialogflow.cx.v3.AdvancedSettings advanced_settings = 22;

Parameter

Name	Description
value	AdvancedSettings

Returns

Type	Description
Agent.Builder

mergeFrom(Agent other)

public Agent.Builder mergeFrom(Agent other)

Parameter

Name	Description
other	Agent

Returns

Type	Description
Agent.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Agent.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Agent.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public Agent.Builder mergeFrom(Message other)

Parameter

Name	Description
other	Message

Returns

Type	Description
Agent.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeSpeechToTextSettings(SpeechToTextSettings value)

public Agent.Builder mergeSpeechToTextSettings(SpeechToTextSettings value)

Speech recognition related settings.

.google.cloud.dialogflow.cx.v3.SpeechToTextSettings speech_to_text_settings = 13;

Parameter

Name	Description
value	SpeechToTextSettings

Returns

Type	Description
Agent.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Agent.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
Agent.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setAdvancedSettings(AdvancedSettings value)

public Agent.Builder setAdvancedSettings(AdvancedSettings value)

Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level.

.google.cloud.dialogflow.cx.v3.AdvancedSettings advanced_settings = 22;

Parameter

Name	Description
value	AdvancedSettings

Returns

Type	Description
Agent.Builder

setAdvancedSettings(AdvancedSettings.Builder builderForValue)

public Agent.Builder setAdvancedSettings(AdvancedSettings.Builder builderForValue)

Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level.

.google.cloud.dialogflow.cx.v3.AdvancedSettings advanced_settings = 22;

Parameter

Name	Description
builderForValue	AdvancedSettings.Builder

Returns

Type	Description
Agent.Builder

setAvatarUri(String value)

public Agent.Builder setAvatarUri(String value)

The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration.

string avatar_uri = 7;

Parameter

Name	Description
value	String The avatarUri to set.

Returns

Type	Description
Agent.Builder	This builder for chaining.

setAvatarUriBytes(ByteString value)

public Agent.Builder setAvatarUriBytes(ByteString value)

The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration.

string avatar_uri = 7;

Parameter

Name	Description
value	ByteString The bytes for avatarUri to set.

Returns

Type	Description
Agent.Builder	This builder for chaining.

setDefaultLanguageCode(String value)

public Agent.Builder setDefaultLanguageCode(String value)

Required. Immutable. The default language of the agent as a language tag. See Language Support for a list of the currently supported language codes. This field cannot be set by the Agents.UpdateAgent method.

string default_language_code = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Parameter

Name	Description
value	String The defaultLanguageCode to set.

Returns

Type	Description
Agent.Builder	This builder for chaining.

setDefaultLanguageCodeBytes(ByteString value)

public Agent.Builder setDefaultLanguageCodeBytes(ByteString value)

Required. Immutable. The default language of the agent as a language tag. See Language Support for a list of the currently supported language codes. This field cannot be set by the Agents.UpdateAgent method.

string default_language_code = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Parameter

Name	Description
value	ByteString The bytes for defaultLanguageCode to set.

Returns

Type	Description
Agent.Builder	This builder for chaining.

setDescription(String value)

public Agent.Builder setDescription(String value)

The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected.

string description = 6;

Parameter

Name	Description
value	String The description to set.

Returns

Type	Description
Agent.Builder	This builder for chaining.

setDescriptionBytes(ByteString value)

public Agent.Builder setDescriptionBytes(ByteString value)

The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected.

string description = 6;

Parameter

Name	Description
value	ByteString The bytes for description to set.

Returns

Type	Description
Agent.Builder	This builder for chaining.

setDisplayName(String value)

public Agent.Builder setDisplayName(String value)

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

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

Parameter

Name	Description
value	String The displayName to set.

Returns

Type	Description
Agent.Builder	This builder for chaining.

setDisplayNameBytes(ByteString value)

public Agent.Builder setDisplayNameBytes(ByteString value)

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

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

Parameter

Name	Description
value	ByteString The bytes for displayName to set.

Returns

Type	Description
Agent.Builder	This builder for chaining.

setEnableSpellCorrection(boolean value)

public Agent.Builder setEnableSpellCorrection(boolean value)

Indicates if automatic spell correction is enabled in detect intent requests.

bool enable_spell_correction = 20;

Parameter

Name	Description
value	boolean The enableSpellCorrection to set.

Returns

Type	Description
Agent.Builder	This builder for chaining.

setEnableStackdriverLogging(boolean value) (deprecated)

public Agent.Builder setEnableStackdriverLogging(boolean value)

Deprecated. google.cloud.dialogflow.cx.v3.Agent.enable_stackdriver_logging is deprecated. See google/cloud/dialogflow/cx/v3/agent.proto;l=245

Indicates if stackdriver logging is enabled for the agent. Please use agent.advanced_settings instead.

bool enable_stackdriver_logging = 18 [deprecated = true];

Parameter

Name	Description
value	boolean The enableStackdriverLogging to set.

Returns

Type	Description
Agent.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Agent.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
Agent.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setLocked(boolean value)

public Agent.Builder setLocked(boolean value)

Indicates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for [RestoreAgent][].

bool locked = 27;

Parameter

Name	Description
value	boolean The locked to set.

Returns

Type	Description
Agent.Builder	This builder for chaining.

setName(String value)

public Agent.Builder setName(String value)

The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

string name = 1;

Parameter

Name	Description
value	String The name to set.

Returns

Type	Description
Agent.Builder	This builder for chaining.

setNameBytes(ByteString value)

public Agent.Builder setNameBytes(ByteString value)

The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

string name = 1;

Parameter

Name	Description
value	ByteString The bytes for name to set.

Returns

Type	Description
Agent.Builder	This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Agent.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters

Name	Description
field	FieldDescriptor
index	int
value	Object

Returns

Type	Description
Agent.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setSecuritySettings(String value)

public Agent.Builder setSecuritySettings(String value)

Name of the SecuritySettings reference for the agent. Format: projects/<Project ID>/locations/<Location ID>/securitySettings/<Security Settings ID>.

string security_settings = 17 [(.google.api.resource_reference) = { ... }

Parameter

Name	Description
value	String The securitySettings to set.

Returns

Type	Description
Agent.Builder	This builder for chaining.

setSecuritySettingsBytes(ByteString value)

public Agent.Builder setSecuritySettingsBytes(ByteString value)

Name of the SecuritySettings reference for the agent. Format: projects/<Project ID>/locations/<Location ID>/securitySettings/<Security Settings ID>.

string security_settings = 17 [(.google.api.resource_reference) = { ... }

Parameter

Name	Description
value	ByteString The bytes for securitySettings to set.

Returns

Type	Description
Agent.Builder	This builder for chaining.

setSpeechToTextSettings(SpeechToTextSettings value)

public Agent.Builder setSpeechToTextSettings(SpeechToTextSettings value)

Speech recognition related settings.

.google.cloud.dialogflow.cx.v3.SpeechToTextSettings speech_to_text_settings = 13;

Parameter

Name	Description
value	SpeechToTextSettings

Returns

Type	Description
Agent.Builder

setSpeechToTextSettings(SpeechToTextSettings.Builder builderForValue)

public Agent.Builder setSpeechToTextSettings(SpeechToTextSettings.Builder builderForValue)

Speech recognition related settings.

.google.cloud.dialogflow.cx.v3.SpeechToTextSettings speech_to_text_settings = 13;

Parameter

Name	Description
builderForValue	SpeechToTextSettings.Builder

Returns

Type	Description
Agent.Builder

setStartFlow(String value)

public Agent.Builder setStartFlow(String value)

Immutable. Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.

string start_flow = 16 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Parameter

Name	Description
value	String The startFlow to set.

Returns

Type	Description
Agent.Builder	This builder for chaining.

setStartFlowBytes(ByteString value)

public Agent.Builder setStartFlowBytes(ByteString value)

Immutable. Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.

string start_flow = 16 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Parameter

Name	Description
value	ByteString The bytes for startFlow to set.

Returns

Type	Description
Agent.Builder	This builder for chaining.

setSupportedLanguageCodes(int index, String value)

public Agent.Builder setSupportedLanguageCodes(int index, String value)

The list of all languages supported by the agent (except for the default_language_code).

repeated string supported_language_codes = 4;

Parameters

Name	Description
index	int The index to set the value at.
value	String The supportedLanguageCodes to set.

Returns

Type	Description
Agent.Builder	This builder for chaining.

setTimeZone(String value)

public Agent.Builder setTimeZone(String value)

Required. The time zone of the agent from the time zone database, e.g., America/New_York, Europe/Paris.

string time_zone = 5 [(.google.api.field_behavior) = REQUIRED];

Parameter

Name	Description
value	String The timeZone to set.

Returns

Type	Description
Agent.Builder	This builder for chaining.

setTimeZoneBytes(ByteString value)

public Agent.Builder setTimeZoneBytes(ByteString value)

Required. The time zone of the agent from the time zone database, e.g., America/New_York, Europe/Paris.

string time_zone = 5 [(.google.api.field_behavior) = REQUIRED];

Parameter

Name	Description
value	ByteString The bytes for timeZone to set.

Returns

Type	Description
Agent.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Agent.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
Agent.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)