Class Engine.ChatEngineConfig.AgentCreationConfig.Builder (0.38.0)

public static final class Engine.ChatEngineConfig.AgentCreationConfig.Builder extends GeneratedMessageV3.Builder<Engine.ChatEngineConfig.AgentCreationConfig.Builder> implements Engine.ChatEngineConfig.AgentCreationConfigOrBuilder

Configurations for generating a Dialogflow agent.

Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.

Protobuf type google.cloud.discoveryengine.v1.Engine.ChatEngineConfig.AgentCreationConfig

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Engine.ChatEngineConfig.AgentCreationConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Engine.ChatEngineConfig.AgentCreationConfig.Builder
Overrides

build()

public Engine.ChatEngineConfig.AgentCreationConfig build()
Returns
Type Description
Engine.ChatEngineConfig.AgentCreationConfig

buildPartial()

public Engine.ChatEngineConfig.AgentCreationConfig buildPartial()
Returns
Type Description
Engine.ChatEngineConfig.AgentCreationConfig

clear()

public Engine.ChatEngineConfig.AgentCreationConfig.Builder clear()
Returns
Type Description
Engine.ChatEngineConfig.AgentCreationConfig.Builder
Overrides

clearBusiness()

public Engine.ChatEngineConfig.AgentCreationConfig.Builder clearBusiness()

Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.

string business = 1;

Returns
Type Description
Engine.ChatEngineConfig.AgentCreationConfig.Builder

This builder for chaining.

clearDefaultLanguageCode()

public Engine.ChatEngineConfig.AgentCreationConfig.Builder clearDefaultLanguageCode()

Required. The default language of the agent as a language tag. See Language Support for a list of the currently supported language codes.

string default_language_code = 2;

Returns
Type Description
Engine.ChatEngineConfig.AgentCreationConfig.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Engine.ChatEngineConfig.AgentCreationConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Engine.ChatEngineConfig.AgentCreationConfig.Builder
Overrides

clearLocation()

public Engine.ChatEngineConfig.AgentCreationConfig.Builder clearLocation()

Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default.

string location = 4;

Returns
Type Description
Engine.ChatEngineConfig.AgentCreationConfig.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Engine.ChatEngineConfig.AgentCreationConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Engine.ChatEngineConfig.AgentCreationConfig.Builder
Overrides

clearTimeZone()

public Engine.ChatEngineConfig.AgentCreationConfig.Builder clearTimeZone()

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

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

Returns
Type Description
Engine.ChatEngineConfig.AgentCreationConfig.Builder

This builder for chaining.

clone()

public Engine.ChatEngineConfig.AgentCreationConfig.Builder clone()
Returns
Type Description
Engine.ChatEngineConfig.AgentCreationConfig.Builder
Overrides

getBusiness()

public String getBusiness()

Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.

string business = 1;

Returns
Type Description
String

The business.

getBusinessBytes()

public ByteString getBusinessBytes()

Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.

string business = 1;

Returns
Type Description
ByteString

The bytes for business.

getDefaultInstanceForType()

public Engine.ChatEngineConfig.AgentCreationConfig getDefaultInstanceForType()
Returns
Type Description
Engine.ChatEngineConfig.AgentCreationConfig

getDefaultLanguageCode()

public String getDefaultLanguageCode()

Required. The default language of the agent as a language tag. See Language Support for a list of the currently supported language codes.

string default_language_code = 2;

Returns
Type Description
String

The defaultLanguageCode.

getDefaultLanguageCodeBytes()

public ByteString getDefaultLanguageCodeBytes()

Required. The default language of the agent as a language tag. See Language Support for a list of the currently supported language codes.

string default_language_code = 2;

Returns
Type Description
ByteString

The bytes for defaultLanguageCode.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getLocation()

public String getLocation()

Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default.

string location = 4;

Returns
Type Description
String

The location.

getLocationBytes()

public ByteString getLocationBytes()

Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default.

string location = 4;

Returns
Type Description
ByteString

The bytes for location.

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 = 3 [(.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 = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for timeZone.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Engine.ChatEngineConfig.AgentCreationConfig other)

public Engine.ChatEngineConfig.AgentCreationConfig.Builder mergeFrom(Engine.ChatEngineConfig.AgentCreationConfig other)
Parameter
Name Description
other Engine.ChatEngineConfig.AgentCreationConfig
Returns
Type Description
Engine.ChatEngineConfig.AgentCreationConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Engine.ChatEngineConfig.AgentCreationConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Engine.ChatEngineConfig.AgentCreationConfig.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Engine.ChatEngineConfig.AgentCreationConfig.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Engine.ChatEngineConfig.AgentCreationConfig.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Engine.ChatEngineConfig.AgentCreationConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Engine.ChatEngineConfig.AgentCreationConfig.Builder
Overrides

setBusiness(String value)

public Engine.ChatEngineConfig.AgentCreationConfig.Builder setBusiness(String value)

Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.

string business = 1;

Parameter
Name Description
value String

The business to set.

Returns
Type Description
Engine.ChatEngineConfig.AgentCreationConfig.Builder

This builder for chaining.

setBusinessBytes(ByteString value)

public Engine.ChatEngineConfig.AgentCreationConfig.Builder setBusinessBytes(ByteString value)

Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.

string business = 1;

Parameter
Name Description
value ByteString

The bytes for business to set.

Returns
Type Description
Engine.ChatEngineConfig.AgentCreationConfig.Builder

This builder for chaining.

setDefaultLanguageCode(String value)

public Engine.ChatEngineConfig.AgentCreationConfig.Builder setDefaultLanguageCode(String value)

Required. The default language of the agent as a language tag. See Language Support for a list of the currently supported language codes.

string default_language_code = 2;

Parameter
Name Description
value String

The defaultLanguageCode to set.

Returns
Type Description
Engine.ChatEngineConfig.AgentCreationConfig.Builder

This builder for chaining.

setDefaultLanguageCodeBytes(ByteString value)

public Engine.ChatEngineConfig.AgentCreationConfig.Builder setDefaultLanguageCodeBytes(ByteString value)

Required. The default language of the agent as a language tag. See Language Support for a list of the currently supported language codes.

string default_language_code = 2;

Parameter
Name Description
value ByteString

The bytes for defaultLanguageCode to set.

Returns
Type Description
Engine.ChatEngineConfig.AgentCreationConfig.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Engine.ChatEngineConfig.AgentCreationConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Engine.ChatEngineConfig.AgentCreationConfig.Builder
Overrides

setLocation(String value)

public Engine.ChatEngineConfig.AgentCreationConfig.Builder setLocation(String value)

Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default.

string location = 4;

Parameter
Name Description
value String

The location to set.

Returns
Type Description
Engine.ChatEngineConfig.AgentCreationConfig.Builder

This builder for chaining.

setLocationBytes(ByteString value)

public Engine.ChatEngineConfig.AgentCreationConfig.Builder setLocationBytes(ByteString value)

Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default.

string location = 4;

Parameter
Name Description
value ByteString

The bytes for location to set.

Returns
Type Description
Engine.ChatEngineConfig.AgentCreationConfig.Builder

This builder for chaining.

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

public Engine.ChatEngineConfig.AgentCreationConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Engine.ChatEngineConfig.AgentCreationConfig.Builder
Overrides

setTimeZone(String value)

public Engine.ChatEngineConfig.AgentCreationConfig.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 = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The timeZone to set.

Returns
Type Description
Engine.ChatEngineConfig.AgentCreationConfig.Builder

This builder for chaining.

setTimeZoneBytes(ByteString value)

public Engine.ChatEngineConfig.AgentCreationConfig.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 = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for timeZone to set.

Returns
Type Description
Engine.ChatEngineConfig.AgentCreationConfig.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Engine.ChatEngineConfig.AgentCreationConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Engine.ChatEngineConfig.AgentCreationConfig.Builder
Overrides