Class EventInput.Builder (4.43.0)

public static final class EventInput.Builder extends GeneratedMessageV3.Builder<EventInput.Builder> implements EventInputOrBuilder

Events allow for matching intents by event name instead of the natural language input. For instance, input <event: { name: "welcome_event", parameters: { name: "Sam" } }> can trigger a personalized welcome response. The parameter name may be used by the agent in the response: "Hello #welcome_event.name! What can I do for you today?".

Protobuf type google.cloud.dialogflow.v2.EventInput

Implements

EventInputOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public EventInput.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
EventInput.Builder
Overrides

build()

public EventInput build()
Returns
TypeDescription
EventInput

buildPartial()

public EventInput buildPartial()
Returns
TypeDescription
EventInput

clear()

public EventInput.Builder clear()
Returns
TypeDescription
EventInput.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public EventInput.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
EventInput.Builder
Overrides

clearLanguageCode()

public EventInput.Builder clearLanguageCode()

Required. The language of this query. See Language Support for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language.

This field is ignored when used in the context of a WebhookResponse.followup_event_input field, because the language was already defined in the originating detect intent request.

string language_code = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
EventInput.Builder

This builder for chaining.

clearName()

public EventInput.Builder clearName()

Required. The unique identifier of the event.

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
EventInput.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public EventInput.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
EventInput.Builder
Overrides

clearParameters()

public EventInput.Builder clearParameters()

The collection of parameters associated with the event.

Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs:

  • MapKey type: string
  • MapKey value: parameter name
  • MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map.
  • MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.

.google.protobuf.Struct parameters = 2;

Returns
TypeDescription
EventInput.Builder

clone()

public EventInput.Builder clone()
Returns
TypeDescription
EventInput.Builder
Overrides

getDefaultInstanceForType()

public EventInput getDefaultInstanceForType()
Returns
TypeDescription
EventInput

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getLanguageCode()

public String getLanguageCode()

Required. The language of this query. See Language Support for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language.

This field is ignored when used in the context of a WebhookResponse.followup_event_input field, because the language was already defined in the originating detect intent request.

string language_code = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The languageCode.

getLanguageCodeBytes()

public ByteString getLanguageCodeBytes()

Required. The language of this query. See Language Support for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language.

This field is ignored when used in the context of a WebhookResponse.followup_event_input field, because the language was already defined in the originating detect intent request.

string language_code = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for languageCode.

getName()

public String getName()

Required. The unique identifier of the event.

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. The unique identifier of the event.

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for name.

getParameters()

public Struct getParameters()

The collection of parameters associated with the event.

Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs:

  • MapKey type: string
  • MapKey value: parameter name
  • MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map.
  • MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.

.google.protobuf.Struct parameters = 2;

Returns
TypeDescription
Struct

The parameters.

getParametersBuilder()

public Struct.Builder getParametersBuilder()

The collection of parameters associated with the event.

Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs:

  • MapKey type: string
  • MapKey value: parameter name
  • MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map.
  • MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.

.google.protobuf.Struct parameters = 2;

Returns
TypeDescription
Builder

getParametersOrBuilder()

public StructOrBuilder getParametersOrBuilder()

The collection of parameters associated with the event.

Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs:

  • MapKey type: string
  • MapKey value: parameter name
  • MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map.
  • MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.

.google.protobuf.Struct parameters = 2;

Returns
TypeDescription
StructOrBuilder

hasParameters()

public boolean hasParameters()

The collection of parameters associated with the event.

Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs:

  • MapKey type: string
  • MapKey value: parameter name
  • MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map.
  • MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.

.google.protobuf.Struct parameters = 2;

Returns
TypeDescription
boolean

Whether the parameters field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(EventInput other)

public EventInput.Builder mergeFrom(EventInput other)
Parameter
NameDescription
otherEventInput
Returns
TypeDescription
EventInput.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public EventInput.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
EventInput.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public EventInput.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
EventInput.Builder
Overrides

mergeParameters(Struct value)

public EventInput.Builder mergeParameters(Struct value)

The collection of parameters associated with the event.

Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs:

  • MapKey type: string
  • MapKey value: parameter name
  • MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map.
  • MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.

.google.protobuf.Struct parameters = 2;

Parameter
NameDescription
valueStruct
Returns
TypeDescription
EventInput.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final EventInput.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
EventInput.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public EventInput.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
EventInput.Builder
Overrides

setLanguageCode(String value)

public EventInput.Builder setLanguageCode(String value)

Required. The language of this query. See Language Support for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language.

This field is ignored when used in the context of a WebhookResponse.followup_event_input field, because the language was already defined in the originating detect intent request.

string language_code = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueString

The languageCode to set.

Returns
TypeDescription
EventInput.Builder

This builder for chaining.

setLanguageCodeBytes(ByteString value)

public EventInput.Builder setLanguageCodeBytes(ByteString value)

Required. The language of this query. See Language Support for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language.

This field is ignored when used in the context of a WebhookResponse.followup_event_input field, because the language was already defined in the originating detect intent request.

string language_code = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueByteString

The bytes for languageCode to set.

Returns
TypeDescription
EventInput.Builder

This builder for chaining.

setName(String value)

public EventInput.Builder setName(String value)

Required. The unique identifier of the event.

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
EventInput.Builder

This builder for chaining.

setNameBytes(ByteString value)

public EventInput.Builder setNameBytes(ByteString value)

Required. The unique identifier of the event.

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
EventInput.Builder

This builder for chaining.

setParameters(Struct value)

public EventInput.Builder setParameters(Struct value)

The collection of parameters associated with the event.

Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs:

  • MapKey type: string
  • MapKey value: parameter name
  • MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map.
  • MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.

.google.protobuf.Struct parameters = 2;

Parameter
NameDescription
valueStruct
Returns
TypeDescription
EventInput.Builder

setParameters(Struct.Builder builderForValue)

public EventInput.Builder setParameters(Struct.Builder builderForValue)

The collection of parameters associated with the event.

Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs:

  • MapKey type: string
  • MapKey value: parameter name
  • MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map.
  • MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.

.google.protobuf.Struct parameters = 2;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
EventInput.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public EventInput.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
EventInput.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final EventInput.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
EventInput.Builder
Overrides