SessionEntityType.Builder (proto-google-cloud-dialogflow-v2beta1 0.122.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderT>
  - - com.google.protobuf.GeneratedMessageV3.Builder<SessionEntityType.Builder>
    - - com.google.cloud.dialogflow.v2beta1.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.GeneratedMessageV3.Builder<SessionEntityType.Builder>
implements SessionEntityTypeOrBuilder

 A session represents a conversation between a Dialogflow agent and an
 end-user. You can create special entities, called session entities, during a
 session. Session entities can extend or replace custom entity types and only
 exist during the session that they were created for. All session data,
 including session entities, is stored by Dialogflow for 20 minutes.
 For more information, see the [session entity
 guide](https://cloud.google.com/dialogflow/docs/entities-session).

Protobuf type google.cloud.dialogflow.v2beta1.SessionEntityType

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SessionEntityType.Builder`	`addAllEntities(Iterable<? extends EntityType.Entity> values)` Required.
`SessionEntityType.Builder`	`addEntities(EntityType.Entity.Builder builderForValue)` Required.
`SessionEntityType.Builder`	`addEntities(EntityType.Entity value)` Required.
`SessionEntityType.Builder`	`addEntities(int index, EntityType.Entity.Builder builderForValue)` Required.
`SessionEntityType.Builder`	`addEntities(int index, EntityType.Entity value)` Required.
`EntityType.Entity.Builder`	`addEntitiesBuilder()` Required.
`EntityType.Entity.Builder`	`addEntitiesBuilder(int index)` Required.
`SessionEntityType.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`SessionEntityType`	`build()`
`SessionEntityType`	`buildPartial()`
`SessionEntityType.Builder`	`clear()`
`SessionEntityType.Builder`	`clearEntities()` Required.
`SessionEntityType.Builder`	`clearEntityOverrideMode()` Required.
`SessionEntityType.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`SessionEntityType.Builder`	`clearName()` Required.
`SessionEntityType.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`SessionEntityType.Builder`	`clone()`
`SessionEntityType`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`EntityType.Entity`	`getEntities(int index)` Required.
`EntityType.Entity.Builder`	`getEntitiesBuilder(int index)` Required.
`List<EntityType.Entity.Builder>`	`getEntitiesBuilderList()` Required.
`int`	`getEntitiesCount()` Required.
`List<EntityType.Entity>`	`getEntitiesList()` Required.
`EntityType.EntityOrBuilder`	`getEntitiesOrBuilder(int index)` Required.
`List<? extends EntityType.EntityOrBuilder>`	`getEntitiesOrBuilderList()` Required.
`SessionEntityType.EntityOverrideMode`	`getEntityOverrideMode()` Required.
`int`	`getEntityOverrideModeValue()` Required.
`String`	`getName()` Required.
`com.google.protobuf.ByteString`	`getNameBytes()` Required.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`SessionEntityType.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`SessionEntityType.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`SessionEntityType.Builder`	`mergeFrom(SessionEntityType other)`
`SessionEntityType.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`SessionEntityType.Builder`	`removeEntities(int index)` Required.
`SessionEntityType.Builder`	`setEntities(int index, EntityType.Entity.Builder builderForValue)` Required.
`SessionEntityType.Builder`	`setEntities(int index, EntityType.Entity value)` Required.
`SessionEntityType.Builder`	`setEntityOverrideMode(SessionEntityType.EntityOverrideMode value)` Required.
`SessionEntityType.Builder`	`setEntityOverrideModeValue(int value)` Required.
`SessionEntityType.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`SessionEntityType.Builder`	`setName(String value)` Required.
`SessionEntityType.Builder`	`setNameBytes(com.google.protobuf.ByteString value)` Required.
`SessionEntityType.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`SessionEntityType.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

Method Detail

getDescriptor

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

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.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.GeneratedMessageV3.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.GeneratedMessageV3.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

clone
```
public SessionEntityType.Builder clone()
```
Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<SessionEntityType.Builder>

setField

public SessionEntityType.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                          Object value)

Specified by:: setField in interface com.google.protobuf.Message.Builder
Overrides:: setField in class com.google.protobuf.GeneratedMessageV3.Builder<SessionEntityType.Builder>

clearField
```
public SessionEntityType.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
```
Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<SessionEntityType.Builder>

clearOneof
```
public SessionEntityType.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
```
Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<SessionEntityType.Builder>

setRepeatedField

public SessionEntityType.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                  int index,
                                                  Object value)

Specified by:: setRepeatedField in interface com.google.protobuf.Message.Builder
Overrides:: setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<SessionEntityType.Builder>

addRepeatedField

public SessionEntityType.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                  Object value)

Specified by:: addRepeatedField in interface com.google.protobuf.Message.Builder
Overrides:: addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<SessionEntityType.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.GeneratedMessageV3.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 this session entity type. Supported
 formats:
 - `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity
   Type Display Name>`
 - `projects/<Project ID>/locations/<Location ID>/agent/sessions/<Session
   ID>/entityTypes/<Entity Type Display Name>`
 - `projects/<Project ID>/agent/environments/<Environment ID>/users/<User
   ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>`
 - `projects/<Project ID>/locations/<Location ID>/agent/environments/
   <Environment ID>/users/<User ID>/sessions/<Session
   ID>/entityTypes/<Entity Type Display Name>`
 If `Location ID` is not specified we assume default 'us' location. 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.

string name = 1;

Specified by:: getName in interface SessionEntityTypeOrBuilder
Returns:: The name.

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 Required. The unique identifier of this session entity type. Supported
 formats:
 - `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity
   Type Display Name>`
 - `projects/<Project ID>/locations/<Location ID>/agent/sessions/<Session
   ID>/entityTypes/<Entity Type Display Name>`
 - `projects/<Project ID>/agent/environments/<Environment ID>/users/<User
   ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>`
 - `projects/<Project ID>/locations/<Location ID>/agent/environments/
   <Environment ID>/users/<User ID>/sessions/<Session
   ID>/entityTypes/<Entity Type Display Name>`
 If `Location ID` is not specified we assume default 'us' location. 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.

string name = 1;

Specified by:: getNameBytes in interface SessionEntityTypeOrBuilder
Returns:: The bytes for name.

setName

public SessionEntityType.Builder setName(String value)

 Required. The unique identifier of this session entity type. Supported
 formats:
 - `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity
   Type Display Name>`
 - `projects/<Project ID>/locations/<Location ID>/agent/sessions/<Session
   ID>/entityTypes/<Entity Type Display Name>`
 - `projects/<Project ID>/agent/environments/<Environment ID>/users/<User
   ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>`
 - `projects/<Project ID>/locations/<Location ID>/agent/environments/
   <Environment ID>/users/<User ID>/sessions/<Session
   ID>/entityTypes/<Entity Type Display Name>`
 If `Location ID` is not specified we assume default 'us' location. 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.

string name = 1;

Parameters:: value - The name to set.
Returns:: This builder for chaining.

clearName

public SessionEntityType.Builder clearName()

 Required. The unique identifier of this session entity type. Supported
 formats:
 - `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity
   Type Display Name>`
 - `projects/<Project ID>/locations/<Location ID>/agent/sessions/<Session
   ID>/entityTypes/<Entity Type Display Name>`
 - `projects/<Project ID>/agent/environments/<Environment ID>/users/<User
   ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>`
 - `projects/<Project ID>/locations/<Location ID>/agent/environments/
   <Environment ID>/users/<User ID>/sessions/<Session
   ID>/entityTypes/<Entity Type Display Name>`
 If `Location ID` is not specified we assume default 'us' location. 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.

string name = 1;

Returns:: This builder for chaining.

setNameBytes

public SessionEntityType.Builder setNameBytes(com.google.protobuf.ByteString value)

 Required. The unique identifier of this session entity type. Supported
 formats:
 - `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity
   Type Display Name>`
 - `projects/<Project ID>/locations/<Location ID>/agent/sessions/<Session
   ID>/entityTypes/<Entity Type Display Name>`
 - `projects/<Project ID>/agent/environments/<Environment ID>/users/<User
   ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>`
 - `projects/<Project ID>/locations/<Location ID>/agent/environments/
   <Environment ID>/users/<User ID>/sessions/<Session
   ID>/entityTypes/<Entity Type Display Name>`
 If `Location ID` is not specified we assume default 'us' location. 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.

string name = 1;

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.v2beta1.SessionEntityType.EntityOverrideMode entity_override_mode = 2;
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.v2beta1.SessionEntityType.EntityOverrideMode entity_override_mode = 2;
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.v2beta1.SessionEntityType.EntityOverrideMode entity_override_mode = 2;
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.v2beta1.SessionEntityType.EntityOverrideMode entity_override_mode = 2;

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.v2beta1.SessionEntityType.EntityOverrideMode entity_override_mode = 2;

Returns:: This builder for chaining.

getEntitiesList
```
public List<EntityType.Entity> getEntitiesList()
```
```
 Required. The collection of entities associated with this session entity
 type.
 
```
repeated .google.cloud.dialogflow.v2beta1.EntityType.Entity entities = 3;
Specified by:

getEntitiesList in interface SessionEntityTypeOrBuilder

getEntitiesCount
```
public int getEntitiesCount()
```
```
 Required. The collection of entities associated with this session entity
 type.
 
```
repeated .google.cloud.dialogflow.v2beta1.EntityType.Entity entities = 3;
Specified by:

getEntitiesCount in interface SessionEntityTypeOrBuilder

getEntities
```
public EntityType.Entity getEntities(int index)
```
```
 Required. The collection of entities associated with this session entity
 type.
 
```
repeated .google.cloud.dialogflow.v2beta1.EntityType.Entity entities = 3;
Specified by:

getEntities in interface SessionEntityTypeOrBuilder