REST Resource: projects.agent.environments.users.sessions.entityTypes

Resource: SessionEntityType

Represents a session entity type.

Extends or replaces a developer entity type at the user session level (we refer to the entity types defined at the agent level as "developer entity types").

Note: session entity types apply to all queries, regardless of the language.

JSON representation
{
  "name": string,
  "entityOverrideMode": enum(EntityOverrideMode),
  "entities": [
    {
      object(Entity)
    }
  ]
}
Fields
name

string

Required. The unique identifier of this session entity type. Format: projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name>, or projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.

<Entity Type Display Name> must be the display name of an existing entity type in the same agent that will be overridden or supplemented.

entityOverrideMode

enum(EntityOverrideMode)

Required. Indicates whether the additional data should override or supplement the developer entity type definition.

entities[]

object(Entity)

Required. The collection of entities associated with this session entity type.

EntityOverrideMode

The types of modifications for a session entity type.

Enums
ENTITY_OVERRIDE_MODE_UNSPECIFIED Not specified. This value should be never used.
ENTITY_OVERRIDE_MODE_OVERRIDE The collection of session entities overrides the collection of entities in the corresponding developer entity type.
ENTITY_OVERRIDE_MODE_SUPPLEMENT

The collection of session entities extends the collection of entities in the corresponding developer entity type.

Note: Even in this override mode calls to entityTypes.list, entityTypes.get, entityTypes.create and entityTypes.patch only return the additional entities added in this session entity type. If you want to get the supplemented list, please call EntityTypes.GetEntityType on the developer entity type and merge.

Methods

create

Creates a session entity type.

delete

Deletes the specified session entity type.

get

Retrieves the specified session entity type.

list

Returns the list of all session entity types in the specified session.

patch

Updates the specified session entity type.