Package com.google.cloud.dialogflow.cx.v3beta1

Class SessionEntityType.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<SessionEntityType.Builder>
com.google.cloud.dialogflow.cx.v3beta1.SessionEntityType.Builder
All Implemented Interfaces:
SessionEntityTypeOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
SessionEntityType
public static final class SessionEntityType.Builder extends com.google.protobuf.GeneratedMessage.Builder<SessionEntityType.Builder> implements SessionEntityTypeOrBuilder
 Session entity types are referred to as **User** entity types and are
 entities that are built for an individual user such as favorites,
 preferences, playlists, and so on.

 You can redefine a session entity type at the session level to extend or
 replace a [custom entity type][google.cloud.dialogflow.cx.v3beta1.EntityType]
 at the user session level (we refer to the entity types defined at the agent
 level as "custom entity types").

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

 For more information about entity types, see the [Dialogflow
 documentation](https://cloud.google.com/dialogflow/docs/entities-overview).
Protobuf type google.cloud.dialogflow.cx.v3beta1.SessionEntityType

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<SessionEntityType.Builder>

    • clear

      public SessionEntityType.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<SessionEntityType.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<SessionEntityType.Builder>

    • getDefaultInstanceForType

      public SessionEntityType getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public SessionEntityType build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public SessionEntityType buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public SessionEntityType.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SessionEntityType.Builder>

    • mergeFrom

      public SessionEntityType.Builder mergeFrom(SessionEntityType other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<SessionEntityType.Builder>

    • mergeFrom

      public SessionEntityType.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SessionEntityType.Builder>
      Throws:
      IOException

    • getName

      public String getName()
       Required. The unique identifier of the session entity type.
 Format:
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/sessions/<SessionID>/entityTypes/<EntityTypeID>`
 or
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/sessions/<SessionID>/entityTypes/<EntityTypeID>`.
 If `Environment ID` is not specified, we assume default 'draft'
 environment.
      string name = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getName in interface SessionEntityTypeOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Required. The unique identifier of the session entity type.
 Format:
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/sessions/<SessionID>/entityTypes/<EntityTypeID>`
 or
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/sessions/<SessionID>/entityTypes/<EntityTypeID>`.
 If `Environment ID` is not specified, we assume default 'draft'
 environment.
      string name = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getNameBytes in interface SessionEntityTypeOrBuilder
      Returns:
      The bytes for name.

    • setName

      public SessionEntityType.Builder setName(String value)
       Required. The unique identifier of the session entity type.
 Format:
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/sessions/<SessionID>/entityTypes/<EntityTypeID>`
 or
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/sessions/<SessionID>/entityTypes/<EntityTypeID>`.
 If `Environment ID` is not specified, we assume default 'draft'
 environment.
      string name = 1 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The name to set.
      Returns:
      This builder for chaining.

    • clearName

      public SessionEntityType.Builder clearName()
       Required. The unique identifier of the session entity type.
 Format:
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/sessions/<SessionID>/entityTypes/<EntityTypeID>`
 or
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/sessions/<SessionID>/entityTypes/<EntityTypeID>`.
 If `Environment ID` is not specified, we assume default 'draft'
 environment.
      string name = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      This builder for chaining.

    • setNameBytes

      public SessionEntityType.Builder setNameBytes(com.google.protobuf.ByteString value)
       Required. The unique identifier of the session entity type.
 Format:
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/sessions/<SessionID>/entityTypes/<EntityTypeID>`
 or
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/sessions/<SessionID>/entityTypes/<EntityTypeID>`.
 If `Environment ID` is not specified, we assume default 'draft'
 environment.
      string name = 1 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The bytes for name to set.
      Returns:
      This builder for chaining.

    • getEntityOverrideModeValue

      public int getEntityOverrideModeValue()
       Required. Indicates whether the additional data should override or
 supplement the custom entity type definition.
      .google.cloud.dialogflow.cx.v3beta1.SessionEntityType.EntityOverrideMode entity_override_mode = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getEntityOverrideModeValue in interface SessionEntityTypeOrBuilder
      Returns:
      The enum numeric value on the wire for entityOverrideMode.

    • setEntityOverrideModeValue

      public SessionEntityType.Builder setEntityOverrideModeValue(int value)
       Required. Indicates whether the additional data should override or
 supplement the custom entity type definition.
      .google.cloud.dialogflow.cx.v3beta1.SessionEntityType.EntityOverrideMode entity_override_mode = 3 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The enum numeric value on the wire for entityOverrideMode to set.
      Returns:
      This builder for chaining.

    • getEntityOverrideMode

      public SessionEntityType.EntityOverrideMode getEntityOverrideMode()
       Required. Indicates whether the additional data should override or
 supplement the custom entity type definition.
      .google.cloud.dialogflow.cx.v3beta1.SessionEntityType.EntityOverrideMode entity_override_mode = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getEntityOverrideMode in interface SessionEntityTypeOrBuilder
      Returns:
      The entityOverrideMode.

    • setEntityOverrideMode

      public SessionEntityType.Builder setEntityOverrideMode(SessionEntityType.EntityOverrideMode value)
       Required. Indicates whether the additional data should override or
 supplement the custom entity type definition.
      .google.cloud.dialogflow.cx.v3beta1.SessionEntityType.EntityOverrideMode entity_override_mode = 3 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The entityOverrideMode to set.
      Returns:
      This builder for chaining.

    • clearEntityOverrideMode

      public SessionEntityType.Builder clearEntityOverrideMode()
       Required. Indicates whether the additional data should override or
 supplement the custom entity type definition.
      .google.cloud.dialogflow.cx.v3beta1.SessionEntityType.EntityOverrideMode entity_override_mode = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      This builder for chaining.

    • getEntitiesList

      public List<EntityType.Entity> getEntitiesList()
       Required. The collection of entities to override or supplement the custom
 entity type.
      repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.Entity entities = 4 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getEntitiesList in interface SessionEntityTypeOrBuilder

    • getEntitiesCount

      public int getEntitiesCount()
       Required. The collection of entities to override or supplement the custom
 entity type.
      repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.Entity entities = 4 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getEntitiesCount in interface SessionEntityTypeOrBuilder

    • getEntities

      public EntityType.Entity getEntities(int index)
       Required. The collection of entities to override or supplement the custom
 entity type.
      repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.Entity entities = 4 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getEntities in interface SessionEntityTypeOrBuilder

    • setEntities

      public SessionEntityType.Builder setEntities(int index, EntityType.Entity value)
       Required. The collection of entities to override or supplement the custom
 entity type.
      repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.Entity entities = 4 [(.google.api.field_behavior) = REQUIRED];

    • setEntities

      public SessionEntityType.Builder setEntities(int index, EntityType.Entity.Builder builderForValue)
       Required. The collection of entities to override or supplement the custom
 entity type.
      repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.Entity entities = 4 [(.google.api.field_behavior) = REQUIRED];

    • addEntities

      public SessionEntityType.Builder addEntities(EntityType.Entity value)
       Required. The collection of entities to override or supplement the custom
 entity type.
      repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.Entity entities = 4 [(.google.api.field_behavior) = REQUIRED];

    • addEntities

      public SessionEntityType.Builder addEntities(int index, EntityType.Entity value)
       Required. The collection of entities to override or supplement the custom
 entity type.
      repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.Entity entities = 4 [(.google.api.field_behavior) = REQUIRED];

    • addEntities

      public SessionEntityType.Builder addEntities(EntityType.Entity.Builder builderForValue)
       Required. The collection of entities to override or supplement the custom
 entity type.
      repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.Entity entities = 4 [(.google.api.field_behavior) = REQUIRED];

    • addEntities

      public SessionEntityType.Builder addEntities(int index, EntityType.Entity.Builder builderForValue)
       Required. The collection of entities to override or supplement the custom
 entity type.
      repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.Entity entities = 4 [(.google.api.field_behavior) = REQUIRED];

    • addAllEntities

      public SessionEntityType.Builder addAllEntities(Iterable<? extends EntityType.Entity> values)
       Required. The collection of entities to override or supplement the custom
 entity type.
      repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.Entity entities = 4 [(.google.api.field_behavior) = REQUIRED];

    • clearEntities

      public SessionEntityType.Builder clearEntities()
       Required. The collection of entities to override or supplement the custom
 entity type.
      repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.Entity entities = 4 [(.google.api.field_behavior) = REQUIRED];

    • removeEntities

      public SessionEntityType.Builder removeEntities(int index)
       Required. The collection of entities to override or supplement the custom
 entity type.
      repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.Entity entities = 4 [(.google.api.field_behavior) = REQUIRED];

    • getEntitiesBuilder

      public EntityType.Entity.Builder getEntitiesBuilder(int index)
       Required. The collection of entities to override or supplement the custom
 entity type.
      repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.Entity entities = 4 [(.google.api.field_behavior) = REQUIRED];

    • getEntitiesOrBuilder

      public EntityType.EntityOrBuilder getEntitiesOrBuilder(int index)
       Required. The collection of entities to override or supplement the custom
 entity type.
      repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.Entity entities = 4 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getEntitiesOrBuilder in interface SessionEntityTypeOrBuilder

    • getEntitiesOrBuilderList

      public List<? extends EntityType.EntityOrBuilder> getEntitiesOrBuilderList()
       Required. The collection of entities to override or supplement the custom
 entity type.
      repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.Entity entities = 4 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getEntitiesOrBuilderList in interface SessionEntityTypeOrBuilder

    • addEntitiesBuilder

      public EntityType.Entity.Builder addEntitiesBuilder()
       Required. The collection of entities to override or supplement the custom
 entity type.
      repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.Entity entities = 4 [(.google.api.field_behavior) = REQUIRED];

    • addEntitiesBuilder

      public EntityType.Entity.Builder addEntitiesBuilder(int index)
       Required. The collection of entities to override or supplement the custom
 entity type.
      repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.Entity entities = 4 [(.google.api.field_behavior) = REQUIRED];

    • getEntitiesBuilderList

      public List<EntityType.Entity.Builder> getEntitiesBuilderList()
       Required. The collection of entities to override or supplement the custom
 entity type.
      repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.Entity entities = 4 [(.google.api.field_behavior) = REQUIRED];