Class Agent.Builder (0.50.0) 

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, TransitionRouteGroups 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

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

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

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

clearAnswerFeedbackSettings()

public Agent.Builder clearAnswerFeedbackSettings()

Optional. Answer feedback collection settings.

.google.cloud.dialogflow.cx.v3.Agent.AnswerFeedbackSettings answer_feedback_settings = 38 [(.google.api.field_behavior) = OPTIONAL];

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=324

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

clearGenAppBuilderSettings()

public Agent.Builder clearGenAppBuilderSettings()

Gen App Builder-related agent-level settings.

optional .google.cloud.dialogflow.cx.v3.Agent.GenAppBuilderSettings gen_app_builder_settings = 33;

Returns
Type Description
Agent.Builder

clearGitIntegrationSettings()

public Agent.Builder clearGitIntegrationSettings()

Git integration settings for this agent.

.google.cloud.dialogflow.cx.v3.Agent.GitIntegrationSettings git_integration_settings = 30;

Returns
Type Description
Agent.Builder

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

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>. Currently only the default start flow with id "00000000-0000-0000-0000-000000000000" is allowed.

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.

clearTextToSpeechSettings()

public Agent.Builder clearTextToSpeechSettings()

Settings on instructing the speech synthesizer on how to generate the output audio content.

.google.cloud.dialogflow.cx.v3.TextToSpeechSettings text_to_speech_settings = 31;

Returns
Type Description
Agent.Builder

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

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

getAnswerFeedbackSettings()

public Agent.AnswerFeedbackSettings getAnswerFeedbackSettings()

Optional. Answer feedback collection settings.

.google.cloud.dialogflow.cx.v3.Agent.AnswerFeedbackSettings answer_feedback_settings = 38 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Agent.AnswerFeedbackSettings

The answerFeedbackSettings.

getAnswerFeedbackSettingsBuilder()

public Agent.AnswerFeedbackSettings.Builder getAnswerFeedbackSettingsBuilder()

Optional. Answer feedback collection settings.

.google.cloud.dialogflow.cx.v3.Agent.AnswerFeedbackSettings answer_feedback_settings = 38 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Agent.AnswerFeedbackSettings.Builder

getAnswerFeedbackSettingsOrBuilder()

public Agent.AnswerFeedbackSettingsOrBuilder getAnswerFeedbackSettingsOrBuilder()

Optional. Answer feedback collection settings.

.google.cloud.dialogflow.cx.v3.Agent.AnswerFeedbackSettings answer_feedback_settings = 38 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Agent.AnswerFeedbackSettingsOrBuilder

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

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=324

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.

getGenAppBuilderSettings()

public Agent.GenAppBuilderSettings getGenAppBuilderSettings()

Gen App Builder-related agent-level settings.

optional .google.cloud.dialogflow.cx.v3.Agent.GenAppBuilderSettings gen_app_builder_settings = 33;

Returns
Type Description
Agent.GenAppBuilderSettings

The genAppBuilderSettings.

getGenAppBuilderSettingsBuilder()

public Agent.GenAppBuilderSettings.Builder getGenAppBuilderSettingsBuilder()

Gen App Builder-related agent-level settings.

optional .google.cloud.dialogflow.cx.v3.Agent.GenAppBuilderSettings gen_app_builder_settings = 33;

Returns
Type Description
Agent.GenAppBuilderSettings.Builder

getGenAppBuilderSettingsOrBuilder()

public Agent.GenAppBuilderSettingsOrBuilder getGenAppBuilderSettingsOrBuilder()

Gen App Builder-related agent-level settings.

optional .google.cloud.dialogflow.cx.v3.Agent.GenAppBuilderSettings gen_app_builder_settings = 33;

Returns
Type Description
Agent.GenAppBuilderSettingsOrBuilder

getGitIntegrationSettings()

public Agent.GitIntegrationSettings getGitIntegrationSettings()

Git integration settings for this agent.

.google.cloud.dialogflow.cx.v3.Agent.GitIntegrationSettings git_integration_settings = 30;

Returns
Type Description
Agent.GitIntegrationSettings

The gitIntegrationSettings.

getGitIntegrationSettingsBuilder()

public Agent.GitIntegrationSettings.Builder getGitIntegrationSettingsBuilder()

Git integration settings for this agent.

.google.cloud.dialogflow.cx.v3.Agent.GitIntegrationSettings git_integration_settings = 30;

Returns
Type Description
Agent.GitIntegrationSettings.Builder

getGitIntegrationSettingsOrBuilder()

public Agent.GitIntegrationSettingsOrBuilder getGitIntegrationSettingsOrBuilder()

Git integration settings for this agent.

.google.cloud.dialogflow.cx.v3.Agent.GitIntegrationSettings git_integration_settings = 30;

Returns
Type Description
Agent.GitIntegrationSettingsOrBuilder

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>. Currently only the default start flow with id "00000000-0000-0000-0000-000000000000" is allowed.

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>. Currently only the default start flow with id "00000000-0000-0000-0000-000000000000" is allowed.

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.

getTextToSpeechSettings()

public TextToSpeechSettings getTextToSpeechSettings()

Settings on instructing the speech synthesizer on how to generate the output audio content.

.google.cloud.dialogflow.cx.v3.TextToSpeechSettings text_to_speech_settings = 31;

Returns
Type Description
TextToSpeechSettings

The textToSpeechSettings.

getTextToSpeechSettingsBuilder()

public TextToSpeechSettings.Builder getTextToSpeechSettingsBuilder()

Settings on instructing the speech synthesizer on how to generate the output audio content.

.google.cloud.dialogflow.cx.v3.TextToSpeechSettings text_to_speech_settings = 31;

Returns
Type Description
TextToSpeechSettings.Builder

getTextToSpeechSettingsOrBuilder()

public TextToSpeechSettingsOrBuilder getTextToSpeechSettingsOrBuilder()

Settings on instructing the speech synthesizer on how to generate the output audio content.

.google.cloud.dialogflow.cx.v3.TextToSpeechSettings text_to_speech_settings = 31;

Returns
Type Description
TextToSpeechSettingsOrBuilder

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.

hasAnswerFeedbackSettings()

public boolean hasAnswerFeedbackSettings()

Optional. Answer feedback collection settings.

.google.cloud.dialogflow.cx.v3.Agent.AnswerFeedbackSettings answer_feedback_settings = 38 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the answerFeedbackSettings field is set.

hasGenAppBuilderSettings()

public boolean hasGenAppBuilderSettings()

Gen App Builder-related agent-level settings.

optional .google.cloud.dialogflow.cx.v3.Agent.GenAppBuilderSettings gen_app_builder_settings = 33;

Returns
Type Description
boolean

Whether the genAppBuilderSettings field is set.

hasGitIntegrationSettings()

public boolean hasGitIntegrationSettings()

Git integration settings for this agent.

.google.cloud.dialogflow.cx.v3.Agent.GitIntegrationSettings git_integration_settings = 30;

Returns
Type Description
boolean

Whether the gitIntegrationSettings 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.

hasTextToSpeechSettings()

public boolean hasTextToSpeechSettings()

Settings on instructing the speech synthesizer on how to generate the output audio content.

.google.cloud.dialogflow.cx.v3.TextToSpeechSettings text_to_speech_settings = 31;

Returns
Type Description
boolean

Whether the textToSpeechSettings field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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

mergeAnswerFeedbackSettings(Agent.AnswerFeedbackSettings value)

public Agent.Builder mergeAnswerFeedbackSettings(Agent.AnswerFeedbackSettings value)

Optional. Answer feedback collection settings.

.google.cloud.dialogflow.cx.v3.Agent.AnswerFeedbackSettings answer_feedback_settings = 38 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Agent.AnswerFeedbackSettings
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
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Agent.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Agent.Builder
Overrides

mergeGenAppBuilderSettings(Agent.GenAppBuilderSettings value)

public Agent.Builder mergeGenAppBuilderSettings(Agent.GenAppBuilderSettings value)

Gen App Builder-related agent-level settings.

optional .google.cloud.dialogflow.cx.v3.Agent.GenAppBuilderSettings gen_app_builder_settings = 33;

Parameter
Name Description
value Agent.GenAppBuilderSettings
Returns
Type Description
Agent.Builder

mergeGitIntegrationSettings(Agent.GitIntegrationSettings value)

public Agent.Builder mergeGitIntegrationSettings(Agent.GitIntegrationSettings value)

Git integration settings for this agent.

.google.cloud.dialogflow.cx.v3.Agent.GitIntegrationSettings git_integration_settings = 30;

Parameter
Name Description
value Agent.GitIntegrationSettings
Returns
Type Description
Agent.Builder

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

mergeTextToSpeechSettings(TextToSpeechSettings value)

public Agent.Builder mergeTextToSpeechSettings(TextToSpeechSettings value)

Settings on instructing the speech synthesizer on how to generate the output audio content.

.google.cloud.dialogflow.cx.v3.TextToSpeechSettings text_to_speech_settings = 31;

Parameter
Name Description
value TextToSpeechSettings
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

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

setAnswerFeedbackSettings(Agent.AnswerFeedbackSettings value)

public Agent.Builder setAnswerFeedbackSettings(Agent.AnswerFeedbackSettings value)

Optional. Answer feedback collection settings.

.google.cloud.dialogflow.cx.v3.Agent.AnswerFeedbackSettings answer_feedback_settings = 38 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Agent.AnswerFeedbackSettings
Returns
Type Description
Agent.Builder

setAnswerFeedbackSettings(Agent.AnswerFeedbackSettings.Builder builderForValue)

public Agent.Builder setAnswerFeedbackSettings(Agent.AnswerFeedbackSettings.Builder builderForValue)

Optional. Answer feedback collection settings.

.google.cloud.dialogflow.cx.v3.Agent.AnswerFeedbackSettings answer_feedback_settings = 38 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue Agent.AnswerFeedbackSettings.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=324

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

setGenAppBuilderSettings(Agent.GenAppBuilderSettings value)

public Agent.Builder setGenAppBuilderSettings(Agent.GenAppBuilderSettings value)

Gen App Builder-related agent-level settings.

optional .google.cloud.dialogflow.cx.v3.Agent.GenAppBuilderSettings gen_app_builder_settings = 33;

Parameter
Name Description
value Agent.GenAppBuilderSettings
Returns
Type Description
Agent.Builder

setGenAppBuilderSettings(Agent.GenAppBuilderSettings.Builder builderForValue)

public Agent.Builder setGenAppBuilderSettings(Agent.GenAppBuilderSettings.Builder builderForValue)

Gen App Builder-related agent-level settings.

optional .google.cloud.dialogflow.cx.v3.Agent.GenAppBuilderSettings gen_app_builder_settings = 33;

Parameter
Name Description
builderForValue Agent.GenAppBuilderSettings.Builder
Returns
Type Description
Agent.Builder

setGitIntegrationSettings(Agent.GitIntegrationSettings value)

public Agent.Builder setGitIntegrationSettings(Agent.GitIntegrationSettings value)

Git integration settings for this agent.

.google.cloud.dialogflow.cx.v3.Agent.GitIntegrationSettings git_integration_settings = 30;

Parameter
Name Description
value Agent.GitIntegrationSettings
Returns
Type Description
Agent.Builder

setGitIntegrationSettings(Agent.GitIntegrationSettings.Builder builderForValue)

public Agent.Builder setGitIntegrationSettings(Agent.GitIntegrationSettings.Builder builderForValue)

Git integration settings for this agent.

.google.cloud.dialogflow.cx.v3.Agent.GitIntegrationSettings git_integration_settings = 30;

Parameter
Name Description
builderForValue Agent.GitIntegrationSettings.Builder
Returns
Type Description
Agent.Builder

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

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>. Currently only the default start flow with id "00000000-0000-0000-0000-000000000000" is allowed.

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>. Currently only the default start flow with id "00000000-0000-0000-0000-000000000000" is allowed.

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.

setTextToSpeechSettings(TextToSpeechSettings value)

public Agent.Builder setTextToSpeechSettings(TextToSpeechSettings value)

Settings on instructing the speech synthesizer on how to generate the output audio content.

.google.cloud.dialogflow.cx.v3.TextToSpeechSettings text_to_speech_settings = 31;

Parameter
Name Description
value TextToSpeechSettings
Returns
Type Description
Agent.Builder

setTextToSpeechSettings(TextToSpeechSettings.Builder builderForValue)

public Agent.Builder setTextToSpeechSettings(TextToSpeechSettings.Builder builderForValue)

Settings on instructing the speech synthesizer on how to generate the output audio content.

.google.cloud.dialogflow.cx.v3.TextToSpeechSettings text_to_speech_settings = 31;

Parameter
Name Description
builderForValue TextToSpeechSettings.Builder
Returns
Type Description
Agent.Builder

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