Class Assistant (0.90.0)

public final class Assistant extends GeneratedMessage implements AssistantOrBuilder

Discovery Engine Assistant resource.

Protobuf type google.cloud.discoveryengine.v1beta.Assistant

Implements

AssistantOrBuilder

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

CUSTOMER_POLICY_FIELD_NUMBER

public static final int CUSTOMER_POLICY_FIELD_NUMBER
Field Value
Type Description
int

DEFAULT_WEB_GROUNDING_TOGGLE_OFF_FIELD_NUMBER

public static final int DEFAULT_WEB_GROUNDING_TOGGLE_OFF_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

ENABLED_TOOLS_FIELD_NUMBER

public static final int ENABLED_TOOLS_FIELD_NUMBER
Field Value
Type Description
int

GENERATION_CONFIG_FIELD_NUMBER

public static final int GENERATION_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

WEB_GROUNDING_TYPE_FIELD_NUMBER

public static final int WEB_GROUNDING_TYPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Assistant getDefaultInstance()
Returns
Type Description
Assistant

getDescriptor()

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

newBuilder()

public static Assistant.Builder newBuilder()
Returns
Type Description
Assistant.Builder

newBuilder(Assistant prototype)

public static Assistant.Builder newBuilder(Assistant prototype)
Parameter
Name Description
prototype Assistant
Returns
Type Description
Assistant.Builder

parseDelimitedFrom(InputStream input)

public static Assistant parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Assistant
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Assistant parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Assistant
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Assistant parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Assistant
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Assistant parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Assistant
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Assistant parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Assistant
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Assistant parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Assistant
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Assistant parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Assistant
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Assistant parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Assistant
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Assistant parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Assistant
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Assistant parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Assistant
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Assistant parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Assistant
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Assistant parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Assistant
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Assistant> parser()
Returns
Type Description
Parser<Assistant>

Methods

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

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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.

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.

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.

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.

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

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.

getParserForType()

public Parser<Assistant> getParserForType()
Returns
Type Description
Parser<Assistant>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

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.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Assistant.Builder newBuilderForType()
Returns
Type Description
Assistant.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected Assistant.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Assistant.Builder
Overrides

toBuilder()

public Assistant.Builder toBuilder()
Returns
Type Description
Assistant.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException