public final class Assistant extends GeneratedMessage implements AssistantOrBuilder
Discovery Engine Assistant resource.
Protobuf type google.cloud.discoveryengine.v1beta.Assistant
Inherited Members
com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)
com.google.protobuf.GeneratedMessage.canUseUnsafe()
com.google.protobuf.GeneratedMessage.emptyBooleanList()
com.google.protobuf.GeneratedMessage.emptyDoubleList()
com.google.protobuf.GeneratedMessage.emptyFloatList()
com.google.protobuf.GeneratedMessage.emptyIntList()
com.google.protobuf.GeneratedMessage.emptyLongList()
com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)
com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)
com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)
com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)
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 |
|
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()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Assistant.Builder newBuilder()
newBuilder(Assistant prototype)
public static Assistant.Builder newBuilder(Assistant prototype)
| Parameter |
| Name |
Description |
prototype |
Assistant
|
public static Assistant parseDelimitedFrom(InputStream input)
public static Assistant parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Assistant parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Assistant parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Assistant parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Assistant parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Assistant parseFrom(CodedInputStream input)
public static Assistant parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Assistant parseFrom(InputStream input)
public static Assistant parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Assistant parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Assistant parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Assistant> parser()
Methods
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
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
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];
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];
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];
getDefaultInstanceForType()
public Assistant getDefaultInstanceForType()
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.
|
public Map<String,Assistant.ToolList> getEnabledTools()
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 |
|
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];
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];
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
|
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];
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];
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()
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];
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];
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()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
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()
Overrides
newBuilderForType()
public Assistant.Builder newBuilderForType()
newBuilderForType(AbstractMessage.BuilderParent parent)
protected Assistant.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Overrides
toBuilder()
public Assistant.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides