Class Assistant.Builder (0.90.0)

0.90.0 (latest) 0.89.0 0.87.0 0.84.0 0.83.0 0.81.0 0.79.0 0.78.0 0.77.0 0.76.0 0.74.0 0.72.0 0.71.0 0.70.0 0.69.0 0.68.0 0.66.0 0.64.0 0.63.0 0.60.0 0.59.0 0.58.0 0.56.0 0.55.0 0.54.0 0.53.0 0.52.0 0.51.0 0.50.0 0.49.0 0.48.0 0.47.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.37.0 0.36.0 0.35.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.20.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.14.0 0.13.0 0.12.0 0.11.0 0.10.0 0.9.0 0.8.0 0.7.0 0.5.0 0.4.0 0.3.0 0.2.0 0.1.0

public static final class Assistant.Builder extends GeneratedMessage.Builder<Assistant.Builder> implements AssistantOrBuilder

Discovery Engine Assistant resource.

Protobuf type google.cloud.discoveryengine.v1beta.Assistant

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > Assistant.Builder

Implements

AssistantOrBuilder

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)

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

GeneratedMessage.Builder.clear()

GeneratedMessage.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.clone()

GeneratedMessage.Builder.getAllFields()

GeneratedMessage.Builder.getDescriptorForType()

GeneratedMessage.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.getParentForChildren()

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

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

GeneratedMessage.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessage.Builder.getUnknownFieldSetBuilder()

GeneratedMessage.Builder.getUnknownFields()

GeneratedMessage.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.internalGetFieldAccessorTable()

GeneratedMessage.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

GeneratedMessage.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessage.Builder.isClean()

GeneratedMessage.Builder.isInitialized()

GeneratedMessage.Builder.markClean()

GeneratedMessage.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownVarintField(int,int)

GeneratedMessage.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.onBuilt()

GeneratedMessage.Builder.onChanged()

com.google.protobuf.GeneratedMessage.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

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

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

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessage.Builder.setUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldsProto3(com.google.protobuf.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

build()

public Assistant build()

Returns
Type	Description
Assistant

buildPartial()

public Assistant buildPartial()

Returns
Type	Description
Assistant

clear()

public Assistant.Builder clear()

Returns
Type	Description
Assistant.Builder

Overrides

GeneratedMessage.Builder<BuilderType>.clear()

clearCreateTime()

public Assistant.Builder clearCreateTime()

Output only. Represents the time when this Assistant was created.

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

Returns
Type	Description
Assistant.Builder

clearCustomerPolicy()

public Assistant.Builder clearCustomerPolicy()

Optional. Customer policy for the assistant.

.google.cloud.discoveryengine.v1beta.Assistant.CustomerPolicy customer_policy = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Assistant.Builder

clearDefaultWebGroundingToggleOff()

public Assistant.Builder clearDefaultWebGroundingToggleOff()

Optional. This field controls the default web grounding toggle for end users if web_grounding_type is set to WEB_GROUNDING_TYPE_GOOGLE_SEARCH or WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH. By default, this field is set to false. If web_grounding_type is WEB_GROUNDING_TYPE_GOOGLE_SEARCH or WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH, end users will have web grounding enabled by default on UI. If true, grounding toggle will be disabled by default on UI. End users can still enable web grounding in the UI if web grounding is enabled.

bool default_web_grounding_toggle_off = 22 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Assistant.Builder	This builder for chaining.

clearDescription()

public Assistant.Builder clearDescription()

Optional. Description for additional information. Expected to be shown on the configuration UI, not to the users of the assistant.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Assistant.Builder	This builder for chaining.

clearDisplayName()

public Assistant.Builder clearDisplayName()

Required. The assistant display name.

It must be a UTF-8 encoded string with a length limit of 128 characters.

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

Returns
Type	Description
Assistant.Builder	This builder for chaining.

clearEnabledTools()

public Assistant.Builder clearEnabledTools()

Returns
Type	Description
Assistant.Builder

clearGenerationConfig()

public Assistant.Builder clearGenerationConfig()

Optional. Configuration for the generation of the assistant response.

.google.cloud.discoveryengine.v1beta.Assistant.GenerationConfig generation_config = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Assistant.Builder

clearName()

public Assistant.Builder clearName()

Immutable. Resource name of the assistant. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

It must be a UTF-8 encoded string with a length limit of 1024 characters.

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
Assistant.Builder	This builder for chaining.

clearUpdateTime()

public Assistant.Builder clearUpdateTime()

Output only. Represents the time when this Assistant was most recently updated.

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

Returns
Type	Description
Assistant.Builder

clearWebGroundingType()

public Assistant.Builder clearWebGroundingType()

Optional. The type of web grounding to use.

.google.cloud.discoveryengine.v1beta.Assistant.WebGroundingType web_grounding_type = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Assistant.Builder	This builder for chaining.

containsEnabledTools(String key)

public boolean containsEnabledTools(String key)

Optional. Note: not implemented yet. Use enabled_actions instead. The enabled tools on this assistant. The keys are connector name, for example "projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector The values consist of admin enabled tools towards the connector instance. Admin can selectively enable multiple tools on any of the connector instances that they created in the project. For example {"jira1ConnectorName": [(toolId1, "createTicket"), (toolId2, "transferTicket")], "gmail1ConnectorName": [(toolId3, "sendEmail"),..] }

map<string, .google.cloud.discoveryengine.v1beta.Assistant.ToolList> enabled_tools = 18 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getCreateTime()

public Timestamp getCreateTime()

Output only. Represents the time when this Assistant was created.

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

Returns
Type	Description
Timestamp	The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. Represents the time when this Assistant was created.

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

Returns
Type	Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Represents the time when this Assistant was created.

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

Returns
Type	Description
TimestampOrBuilder

getCustomerPolicy()

public Assistant.CustomerPolicy getCustomerPolicy()

Optional. Customer policy for the assistant.

.google.cloud.discoveryengine.v1beta.Assistant.CustomerPolicy customer_policy = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Assistant.CustomerPolicy	The customerPolicy.

getCustomerPolicyBuilder()

public Assistant.CustomerPolicy.Builder getCustomerPolicyBuilder()

Optional. Customer policy for the assistant.

.google.cloud.discoveryengine.v1beta.Assistant.CustomerPolicy customer_policy = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Assistant.CustomerPolicy.Builder

getCustomerPolicyOrBuilder()

public Assistant.CustomerPolicyOrBuilder getCustomerPolicyOrBuilder()

Optional. Customer policy for the assistant.

.google.cloud.discoveryengine.v1beta.Assistant.CustomerPolicy customer_policy = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Assistant.CustomerPolicyOrBuilder

getDefaultInstanceForType()

public Assistant getDefaultInstanceForType()

Returns
Type	Description
Assistant

getDefaultWebGroundingToggleOff()

public boolean getDefaultWebGroundingToggleOff()

Optional. This field controls the default web grounding toggle for end users if web_grounding_type is set to WEB_GROUNDING_TYPE_GOOGLE_SEARCH or WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH. By default, this field is set to false. If web_grounding_type is WEB_GROUNDING_TYPE_GOOGLE_SEARCH or WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH, end users will have web grounding enabled by default on UI. If true, grounding toggle will be disabled by default on UI. End users can still enable web grounding in the UI if web grounding is enabled.

bool default_web_grounding_toggle_off = 22 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The defaultWebGroundingToggleOff.

getDescription()

public String getDescription()

Optional. Description for additional information. Expected to be shown on the configuration UI, not to the users of the assistant.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. Description for additional information. Expected to be shown on the configuration UI, not to the users of the assistant.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

getDisplayName()

public String getDisplayName()

Required. The assistant display name.

It must be a UTF-8 encoded string with a length limit of 128 characters.

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

Returns
Type	Description
String	The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Required. The assistant display name.

It must be a UTF-8 encoded string with a length limit of 128 characters.

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

Returns
Type	Description
ByteString	The bytes for displayName.

getEnabledTools() (deprecated)

public Map<String,Assistant.ToolList> getEnabledTools()

Use #getEnabledToolsMap() instead.

Returns
Type	Description
Map<String,ToolList>

getEnabledToolsCount()

public int getEnabledToolsCount()

Optional. Note: not implemented yet. Use enabled_actions instead. The enabled tools on this assistant. The keys are connector name, for example "projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector The values consist of admin enabled tools towards the connector instance. Admin can selectively enable multiple tools on any of the connector instances that they created in the project. For example {"jira1ConnectorName": [(toolId1, "createTicket"), (toolId2, "transferTicket")], "gmail1ConnectorName": [(toolId3, "sendEmail"),..] }

map<string, .google.cloud.discoveryengine.v1beta.Assistant.ToolList> enabled_tools = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int

getEnabledToolsMap()

public Map<String,Assistant.ToolList> getEnabledToolsMap()

Optional. Note: not implemented yet. Use enabled_actions instead. The enabled tools on this assistant. The keys are connector name, for example "projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector The values consist of admin enabled tools towards the connector instance. Admin can selectively enable multiple tools on any of the connector instances that they created in the project. For example {"jira1ConnectorName": [(toolId1, "createTicket"), (toolId2, "transferTicket")], "gmail1ConnectorName": [(toolId3, "sendEmail"),..] }

map<string, .google.cloud.discoveryengine.v1beta.Assistant.ToolList> enabled_tools = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Map<String,ToolList>

getEnabledToolsOrDefault(String key, Assistant.ToolList defaultValue)

public Assistant.ToolList getEnabledToolsOrDefault(String key, Assistant.ToolList defaultValue)

Optional. Note: not implemented yet. Use enabled_actions instead. The enabled tools on this assistant. The keys are connector name, for example "projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector The values consist of admin enabled tools towards the connector instance. Admin can selectively enable multiple tools on any of the connector instances that they created in the project. For example {"jira1ConnectorName": [(toolId1, "createTicket"), (toolId2, "transferTicket")], "gmail1ConnectorName": [(toolId3, "sendEmail"),..] }

map<string, .google.cloud.discoveryengine.v1beta.Assistant.ToolList> enabled_tools = 18 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
key	String
defaultValue	Assistant.ToolList

Returns
Type	Description
Assistant.ToolList

getEnabledToolsOrThrow(String key)

public Assistant.ToolList getEnabledToolsOrThrow(String key)

Optional. Note: not implemented yet. Use enabled_actions instead. The enabled tools on this assistant. The keys are connector name, for example "projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector The values consist of admin enabled tools towards the connector instance. Admin can selectively enable multiple tools on any of the connector instances that they created in the project. For example {"jira1ConnectorName": [(toolId1, "createTicket"), (toolId2, "transferTicket")], "gmail1ConnectorName": [(toolId3, "sendEmail"),..] }

map<string, .google.cloud.discoveryengine.v1beta.Assistant.ToolList> enabled_tools = 18 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
key	String

Returns
Type	Description
Assistant.ToolList

getGenerationConfig()

public Assistant.GenerationConfig getGenerationConfig()

Optional. Configuration for the generation of the assistant response.

.google.cloud.discoveryengine.v1beta.Assistant.GenerationConfig generation_config = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Assistant.GenerationConfig	The generationConfig.

getGenerationConfigBuilder()

public Assistant.GenerationConfig.Builder getGenerationConfigBuilder()

Optional. Configuration for the generation of the assistant response.

.google.cloud.discoveryengine.v1beta.Assistant.GenerationConfig generation_config = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Assistant.GenerationConfig.Builder

getGenerationConfigOrBuilder()

public Assistant.GenerationConfigOrBuilder getGenerationConfigOrBuilder()

Optional. Configuration for the generation of the assistant response.

.google.cloud.discoveryengine.v1beta.Assistant.GenerationConfig generation_config = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Assistant.GenerationConfigOrBuilder

getMutableEnabledTools() (deprecated)

public Map<String,Assistant.ToolList> getMutableEnabledTools()

Use alternate mutation accessors instead.

Returns
Type	Description
Map<String,ToolList>

getName()

public String getName()

Immutable. Resource name of the assistant. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

It must be a UTF-8 encoded string with a length limit of 1024 characters.

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
String	The name.

getNameBytes()

public ByteString getNameBytes()

Immutable. Resource name of the assistant. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

It must be a UTF-8 encoded string with a length limit of 1024 characters.

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
ByteString	The bytes for name.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Represents the time when this Assistant was most recently updated.

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

Returns
Type	Description
Timestamp	The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. Represents the time when this Assistant was most recently updated.

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

Returns
Type	Description
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Represents the time when this Assistant was most recently updated.

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

Returns
Type	Description
TimestampOrBuilder

getWebGroundingType()

public Assistant.WebGroundingType getWebGroundingType()

Optional. The type of web grounding to use.

.google.cloud.discoveryengine.v1beta.Assistant.WebGroundingType web_grounding_type = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Assistant.WebGroundingType	The webGroundingType.

getWebGroundingTypeValue()

public int getWebGroundingTypeValue()

Optional. The type of web grounding to use.

.google.cloud.discoveryengine.v1beta.Assistant.WebGroundingType web_grounding_type = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The enum numeric value on the wire for webGroundingType.

hasCreateTime()

public boolean hasCreateTime()

Output only. Represents the time when this Assistant was created.

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

Returns
Type	Description
boolean	Whether the createTime field is set.

hasCustomerPolicy()

public boolean hasCustomerPolicy()

Optional. Customer policy for the assistant.

.google.cloud.discoveryengine.v1beta.Assistant.CustomerPolicy customer_policy = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the customerPolicy field is set.

hasGenerationConfig()

public boolean hasGenerationConfig()

Optional. Configuration for the generation of the assistant response.

.google.cloud.discoveryengine.v1beta.Assistant.GenerationConfig generation_config = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the generationConfig field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Represents the time when this Assistant was most recently updated.

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

Returns
Type	Description
boolean	Whether the updateTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.Builder<BuilderType>.internalGetFieldAccessorTable()

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)

Parameter
Name	Description
number	int

Returns
Type	Description
com.google.protobuf.MapFieldReflectionAccessor

Overrides

com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)

Parameter
Name	Description
number	int

Returns
Type	Description
com.google.protobuf.MapFieldReflectionAccessor

Overrides

com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.Builder<BuilderType>.isInitialized()

mergeCreateTime(Timestamp value)

public Assistant.Builder mergeCreateTime(Timestamp value)

Output only. Represents the time when this Assistant was created.

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

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
Assistant.Builder

mergeCustomerPolicy(Assistant.CustomerPolicy value)

public Assistant.Builder mergeCustomerPolicy(Assistant.CustomerPolicy value)

Optional. Customer policy for the assistant.

.google.cloud.discoveryengine.v1beta.Assistant.CustomerPolicy customer_policy = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	Assistant.CustomerPolicy

Returns
Type	Description
Assistant.Builder

mergeFrom(Assistant other)

public Assistant.Builder mergeFrom(Assistant other)

Parameter
Name	Description
other	Assistant

Returns
Type	Description
Assistant.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Assistant.Builder

Overrides

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

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public Assistant.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
Assistant.Builder

Overrides

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

mergeGenerationConfig(Assistant.GenerationConfig value)

public Assistant.Builder mergeGenerationConfig(Assistant.GenerationConfig value)

Optional. Configuration for the generation of the assistant response.

.google.cloud.discoveryengine.v1beta.Assistant.GenerationConfig generation_config = 19 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	Assistant.GenerationConfig

Returns
Type	Description
Assistant.Builder

mergeUpdateTime(Timestamp value)

public Assistant.Builder mergeUpdateTime(Timestamp value)

Output only. Represents the time when this Assistant was most recently updated.

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

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
Assistant.Builder

putAllEnabledTools(Map<String,Assistant.ToolList> values)

public Assistant.Builder putAllEnabledTools(Map<String,Assistant.ToolList> values)

Optional. Note: not implemented yet. Use enabled_actions instead. The enabled tools on this assistant. The keys are connector name, for example "projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector The values consist of admin enabled tools towards the connector instance. Admin can selectively enable multiple tools on any of the connector instances that they created in the project. For example {"jira1ConnectorName": [(toolId1, "createTicket"), (toolId2, "transferTicket")], "gmail1ConnectorName": [(toolId3, "sendEmail"),..] }

map<string, .google.cloud.discoveryengine.v1beta.Assistant.ToolList> enabled_tools = 18 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
values	Map<String,ToolList>

Returns
Type	Description
Assistant.Builder

putEnabledTools(String key, Assistant.ToolList value)

public Assistant.Builder putEnabledTools(String key, Assistant.ToolList value)

Optional. Note: not implemented yet. Use enabled_actions instead. The enabled tools on this assistant. The keys are connector name, for example "projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector The values consist of admin enabled tools towards the connector instance. Admin can selectively enable multiple tools on any of the connector instances that they created in the project. For example {"jira1ConnectorName": [(toolId1, "createTicket"), (toolId2, "transferTicket")], "gmail1ConnectorName": [(toolId3, "sendEmail"),..] }

map<string, .google.cloud.discoveryengine.v1beta.Assistant.ToolList> enabled_tools = 18 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
key	String
value	Assistant.ToolList

Returns
Type	Description
Assistant.Builder

putEnabledToolsBuilderIfAbsent(String key)

public Assistant.ToolList.Builder putEnabledToolsBuilderIfAbsent(String key)

Optional. Note: not implemented yet. Use enabled_actions instead. The enabled tools on this assistant. The keys are connector name, for example "projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector The values consist of admin enabled tools towards the connector instance. Admin can selectively enable multiple tools on any of the connector instances that they created in the project. For example {"jira1ConnectorName": [(toolId1, "createTicket"), (toolId2, "transferTicket")], "gmail1ConnectorName": [(toolId3, "sendEmail"),..] }

map<string, .google.cloud.discoveryengine.v1beta.Assistant.ToolList> enabled_tools = 18 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
key	String

Returns
Type	Description
Assistant.ToolList.Builder

removeEnabledTools(String key)

public Assistant.Builder removeEnabledTools(String key)

Optional. Note: not implemented yet. Use enabled_actions instead. The enabled tools on this assistant. The keys are connector name, for example "projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector The values consist of admin enabled tools towards the connector instance. Admin can selectively enable multiple tools on any of the connector instances that they created in the project. For example {"jira1ConnectorName": [(toolId1, "createTicket"), (toolId2, "transferTicket")], "gmail1ConnectorName": [(toolId3, "sendEmail"),..] }

map<string, .google.cloud.discoveryengine.v1beta.Assistant.ToolList> enabled_tools = 18 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
key	String

Returns
Type	Description
Assistant.Builder

setCreateTime(Timestamp value)

public Assistant.Builder setCreateTime(Timestamp value)

Output only. Represents the time when this Assistant was created.

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

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
Assistant.Builder

setCreateTime(Timestamp.Builder builderForValue)

public Assistant.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Represents the time when this Assistant was created.

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

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
Assistant.Builder

setCustomerPolicy(Assistant.CustomerPolicy value)

public Assistant.Builder setCustomerPolicy(Assistant.CustomerPolicy value)

Optional. Customer policy for the assistant.

.google.cloud.discoveryengine.v1beta.Assistant.CustomerPolicy customer_policy = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	Assistant.CustomerPolicy

Returns
Type	Description
Assistant.Builder

setCustomerPolicy(Assistant.CustomerPolicy.Builder builderForValue)

public Assistant.Builder setCustomerPolicy(Assistant.CustomerPolicy.Builder builderForValue)

Optional. Customer policy for the assistant.

.google.cloud.discoveryengine.v1beta.Assistant.CustomerPolicy customer_policy = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
builderForValue	Assistant.CustomerPolicy.Builder

Returns
Type	Description
Assistant.Builder

setDefaultWebGroundingToggleOff(boolean value)

public Assistant.Builder setDefaultWebGroundingToggleOff(boolean value)

Optional. This field controls the default web grounding toggle for end users if web_grounding_type is set to WEB_GROUNDING_TYPE_GOOGLE_SEARCH or WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH. By default, this field is set to false. If web_grounding_type is WEB_GROUNDING_TYPE_GOOGLE_SEARCH or WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH, end users will have web grounding enabled by default on UI. If true, grounding toggle will be disabled by default on UI. End users can still enable web grounding in the UI if web grounding is enabled.

bool default_web_grounding_toggle_off = 22 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	boolean The defaultWebGroundingToggleOff to set.

Returns
Type	Description
Assistant.Builder	This builder for chaining.

setDescription(String value)

public Assistant.Builder setDescription(String value)

Optional. Description for additional information. Expected to be shown on the configuration UI, not to the users of the assistant.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	String The description to set.

Returns
Type	Description
Assistant.Builder	This builder for chaining.

setDescriptionBytes(ByteString value)

public Assistant.Builder setDescriptionBytes(ByteString value)

Optional. Description for additional information. Expected to be shown on the configuration UI, not to the users of the assistant.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	ByteString The bytes for description to set.

Returns
Type	Description
Assistant.Builder	This builder for chaining.

setDisplayName(String value)

public Assistant.Builder setDisplayName(String value)

Required. The assistant display name.

It must be a UTF-8 encoded string with a length limit of 128 characters.

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

Parameter
Name	Description
value	String The displayName to set.

Returns
Type	Description
Assistant.Builder	This builder for chaining.

setDisplayNameBytes(ByteString value)

public Assistant.Builder setDisplayNameBytes(ByteString value)

Required. The assistant display name.

It must be a UTF-8 encoded string with a length limit of 128 characters.

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

Parameter
Name	Description
value	ByteString The bytes for displayName to set.

Returns
Type	Description
Assistant.Builder	This builder for chaining.

setGenerationConfig(Assistant.GenerationConfig value)

public Assistant.Builder setGenerationConfig(Assistant.GenerationConfig value)

Optional. Configuration for the generation of the assistant response.

.google.cloud.discoveryengine.v1beta.Assistant.GenerationConfig generation_config = 19 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	Assistant.GenerationConfig

Returns
Type	Description
Assistant.Builder

setGenerationConfig(Assistant.GenerationConfig.Builder builderForValue)

public Assistant.Builder setGenerationConfig(Assistant.GenerationConfig.Builder builderForValue)

Optional. Configuration for the generation of the assistant response.

.google.cloud.discoveryengine.v1beta.Assistant.GenerationConfig generation_config = 19 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
builderForValue	Assistant.GenerationConfig.Builder

Returns
Type	Description
Assistant.Builder

setName(String value)

public Assistant.Builder setName(String value)

Immutable. Resource name of the assistant. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

It must be a UTF-8 encoded string with a length limit of 1024 characters.

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name	Description
value	String The name to set.

Returns
Type	Description
Assistant.Builder	This builder for chaining.

setNameBytes(ByteString value)

public Assistant.Builder setNameBytes(ByteString value)

Immutable. Resource name of the assistant. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

It must be a UTF-8 encoded string with a length limit of 1024 characters.

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name	Description
value	ByteString The bytes for name to set.

Returns
Type	Description
Assistant.Builder	This builder for chaining.

setUpdateTime(Timestamp value)

public Assistant.Builder setUpdateTime(Timestamp value)

Output only. Represents the time when this Assistant was most recently updated.

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

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
Assistant.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public Assistant.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. Represents the time when this Assistant was most recently updated.

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

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
Assistant.Builder

setWebGroundingType(Assistant.WebGroundingType value)

public Assistant.Builder setWebGroundingType(Assistant.WebGroundingType value)

Optional. The type of web grounding to use.

.google.cloud.discoveryengine.v1beta.Assistant.WebGroundingType web_grounding_type = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	Assistant.WebGroundingType The webGroundingType to set.

Returns
Type	Description
Assistant.Builder	This builder for chaining.

setWebGroundingTypeValue(int value)

public Assistant.Builder setWebGroundingTypeValue(int value)

Optional. The type of web grounding to use.

.google.cloud.discoveryengine.v1beta.Assistant.WebGroundingType web_grounding_type = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	int The enum numeric value on the wire for webGroundingType to set.

Returns
Type	Description
Assistant.Builder	This builder for chaining.