Class SessionInput.Builder (0.1.0)

public static final class SessionInput.Builder extends GeneratedMessage.Builder<SessionInput.Builder> implements SessionInputOrBuilder

Input for the session.

Protobuf type google.cloud.ces.v1.SessionInput

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

build()

public SessionInput build()
Returns
Type Description
SessionInput

buildPartial()

public SessionInput buildPartial()
Returns
Type Description
SessionInput

clear()

public SessionInput.Builder clear()
Returns
Type Description
SessionInput.Builder
Overrides

clearAudio()

public SessionInput.Builder clearAudio()

Optional. Audio data from the end user.

bytes audio = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SessionInput.Builder

This builder for chaining.

clearBlob()

public SessionInput.Builder clearBlob()

Optional. Blob data from the end user.

.google.cloud.ces.v1.Blob blob = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SessionInput.Builder

clearDtmf()

public SessionInput.Builder clearDtmf()

Optional. DTMF digits from the end user.

string dtmf = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SessionInput.Builder

This builder for chaining.

clearEvent()

public SessionInput.Builder clearEvent()

Optional. Event input.

.google.cloud.ces.v1.Event event = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SessionInput.Builder

clearImage()

public SessionInput.Builder clearImage()

Optional. Image data from the end user.

.google.cloud.ces.v1.Image image = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SessionInput.Builder

clearInputType()

public SessionInput.Builder clearInputType()
Returns
Type Description
SessionInput.Builder

clearText()

public SessionInput.Builder clearText()

Optional. Text data from the end user.

string text = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SessionInput.Builder

This builder for chaining.

clearToolResponses()

public SessionInput.Builder clearToolResponses()

Optional. Execution results for the tool calls from the client.

.google.cloud.ces.v1.ToolResponses tool_responses = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SessionInput.Builder

clearVariables()

public SessionInput.Builder clearVariables()

Optional. Contextual variables for the session, keyed by name. Only variables declared in the app will be used by the CES agent.

Unrecognized variables will still be sent to the Dialogflow agent as additional session parameters.

.google.protobuf.Struct variables = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SessionInput.Builder

clearWillContinue()

public SessionInput.Builder clearWillContinue()

Optional. A flag to indicate if the current message is a fragment of a larger input in the bidi streaming session. When true, the agent will defer processing until a subsequent message with will_continue set to false is received.

Note: This flag has no effect on audio and DTMF inputs, which are always processed in real-time.

bool will_continue = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SessionInput.Builder

This builder for chaining.

getAudio()

public ByteString getAudio()

Optional. Audio data from the end user.

bytes audio = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The audio.

getBlob()

public Blob getBlob()

Optional. Blob data from the end user.

.google.cloud.ces.v1.Blob blob = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Blob

The blob.

getBlobBuilder()

public Blob.Builder getBlobBuilder()

Optional. Blob data from the end user.

.google.cloud.ces.v1.Blob blob = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Blob.Builder

getBlobOrBuilder()

public BlobOrBuilder getBlobOrBuilder()

Optional. Blob data from the end user.

.google.cloud.ces.v1.Blob blob = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
BlobOrBuilder

getDefaultInstanceForType()

public SessionInput getDefaultInstanceForType()
Returns
Type Description
SessionInput

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDtmf()

public String getDtmf()

Optional. DTMF digits from the end user.

string dtmf = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The dtmf.

getDtmfBytes()

public ByteString getDtmfBytes()

Optional. DTMF digits from the end user.

string dtmf = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for dtmf.

getEvent()

public Event getEvent()

Optional. Event input.

.google.cloud.ces.v1.Event event = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Event

The event.

getEventBuilder()

public Event.Builder getEventBuilder()

Optional. Event input.

.google.cloud.ces.v1.Event event = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Event.Builder

getEventOrBuilder()

public EventOrBuilder getEventOrBuilder()

Optional. Event input.

.google.cloud.ces.v1.Event event = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
EventOrBuilder

getImage()

public Image getImage()

Optional. Image data from the end user.

.google.cloud.ces.v1.Image image = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Image

The image.

getImageBuilder()

public Image.Builder getImageBuilder()

Optional. Image data from the end user.

.google.cloud.ces.v1.Image image = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Image.Builder

getImageOrBuilder()

public ImageOrBuilder getImageOrBuilder()

Optional. Image data from the end user.

.google.cloud.ces.v1.Image image = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ImageOrBuilder

getInputTypeCase()

public SessionInput.InputTypeCase getInputTypeCase()
Returns
Type Description
SessionInput.InputTypeCase

getText()

public String getText()

Optional. Text data from the end user.

string text = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The text.

getTextBytes()

public ByteString getTextBytes()

Optional. Text data from the end user.

string text = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for text.

getToolResponses()

public ToolResponses getToolResponses()

Optional. Execution results for the tool calls from the client.

.google.cloud.ces.v1.ToolResponses tool_responses = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ToolResponses

The toolResponses.

getToolResponsesBuilder()

public ToolResponses.Builder getToolResponsesBuilder()

Optional. Execution results for the tool calls from the client.

.google.cloud.ces.v1.ToolResponses tool_responses = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ToolResponses.Builder

getToolResponsesOrBuilder()

public ToolResponsesOrBuilder getToolResponsesOrBuilder()

Optional. Execution results for the tool calls from the client.

.google.cloud.ces.v1.ToolResponses tool_responses = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ToolResponsesOrBuilder

getVariables()

public Struct getVariables()

Optional. Contextual variables for the session, keyed by name. Only variables declared in the app will be used by the CES agent.

Unrecognized variables will still be sent to the Dialogflow agent as additional session parameters.

.google.protobuf.Struct variables = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Struct

The variables.

getVariablesBuilder()

public Struct.Builder getVariablesBuilder()

Optional. Contextual variables for the session, keyed by name. Only variables declared in the app will be used by the CES agent.

Unrecognized variables will still be sent to the Dialogflow agent as additional session parameters.

.google.protobuf.Struct variables = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Builder

getVariablesOrBuilder()

public StructOrBuilder getVariablesOrBuilder()

Optional. Contextual variables for the session, keyed by name. Only variables declared in the app will be used by the CES agent.

Unrecognized variables will still be sent to the Dialogflow agent as additional session parameters.

.google.protobuf.Struct variables = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
StructOrBuilder

getWillContinue()

public boolean getWillContinue()

Optional. A flag to indicate if the current message is a fragment of a larger input in the bidi streaming session. When true, the agent will defer processing until a subsequent message with will_continue set to false is received.

Note: This flag has no effect on audio and DTMF inputs, which are always processed in real-time.

bool will_continue = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The willContinue.

hasAudio()

public boolean hasAudio()

Optional. Audio data from the end user.

bytes audio = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the audio field is set.

hasBlob()

public boolean hasBlob()

Optional. Blob data from the end user.

.google.cloud.ces.v1.Blob blob = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the blob field is set.

hasDtmf()

public boolean hasDtmf()

Optional. DTMF digits from the end user.

string dtmf = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the dtmf field is set.

hasEvent()

public boolean hasEvent()

Optional. Event input.

.google.cloud.ces.v1.Event event = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the event field is set.

hasImage()

public boolean hasImage()

Optional. Image data from the end user.

.google.cloud.ces.v1.Image image = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the image field is set.

hasText()

public boolean hasText()

Optional. Text data from the end user.

string text = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the text field is set.

hasToolResponses()

public boolean hasToolResponses()

Optional. Execution results for the tool calls from the client.

.google.cloud.ces.v1.ToolResponses tool_responses = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the toolResponses field is set.

hasVariables()

public boolean hasVariables()

Optional. Contextual variables for the session, keyed by name. Only variables declared in the app will be used by the CES agent.

Unrecognized variables will still be sent to the Dialogflow agent as additional session parameters.

.google.protobuf.Struct variables = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the variables field is set.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeBlob(Blob value)

public SessionInput.Builder mergeBlob(Blob value)

Optional. Blob data from the end user.

.google.cloud.ces.v1.Blob blob = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Blob
Returns
Type Description
SessionInput.Builder

mergeEvent(Event value)

public SessionInput.Builder mergeEvent(Event value)

Optional. Event input.

.google.cloud.ces.v1.Event event = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Event
Returns
Type Description
SessionInput.Builder

mergeFrom(SessionInput other)

public SessionInput.Builder mergeFrom(SessionInput other)
Parameter
Name Description
other SessionInput
Returns
Type Description
SessionInput.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SessionInput.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SessionInput.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public SessionInput.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
SessionInput.Builder
Overrides

mergeImage(Image value)

public SessionInput.Builder mergeImage(Image value)

Optional. Image data from the end user.

.google.cloud.ces.v1.Image image = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Image
Returns
Type Description
SessionInput.Builder

mergeToolResponses(ToolResponses value)

public SessionInput.Builder mergeToolResponses(ToolResponses value)

Optional. Execution results for the tool calls from the client.

.google.cloud.ces.v1.ToolResponses tool_responses = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ToolResponses
Returns
Type Description
SessionInput.Builder

mergeVariables(Struct value)

public SessionInput.Builder mergeVariables(Struct value)

Optional. Contextual variables for the session, keyed by name. Only variables declared in the app will be used by the CES agent.

Unrecognized variables will still be sent to the Dialogflow agent as additional session parameters.

.google.protobuf.Struct variables = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Struct
Returns
Type Description
SessionInput.Builder

setAudio(ByteString value)

public SessionInput.Builder setAudio(ByteString value)

Optional. Audio data from the end user.

bytes audio = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The audio to set.

Returns
Type Description
SessionInput.Builder

This builder for chaining.

setBlob(Blob value)

public SessionInput.Builder setBlob(Blob value)

Optional. Blob data from the end user.

.google.cloud.ces.v1.Blob blob = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Blob
Returns
Type Description
SessionInput.Builder

setBlob(Blob.Builder builderForValue)

public SessionInput.Builder setBlob(Blob.Builder builderForValue)

Optional. Blob data from the end user.

.google.cloud.ces.v1.Blob blob = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue Blob.Builder
Returns
Type Description
SessionInput.Builder

setDtmf(String value)

public SessionInput.Builder setDtmf(String value)

Optional. DTMF digits from the end user.

string dtmf = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The dtmf to set.

Returns
Type Description
SessionInput.Builder

This builder for chaining.

setDtmfBytes(ByteString value)

public SessionInput.Builder setDtmfBytes(ByteString value)

Optional. DTMF digits from the end user.

string dtmf = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for dtmf to set.

Returns
Type Description
SessionInput.Builder

This builder for chaining.

setEvent(Event value)

public SessionInput.Builder setEvent(Event value)

Optional. Event input.

.google.cloud.ces.v1.Event event = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Event
Returns
Type Description
SessionInput.Builder

setEvent(Event.Builder builderForValue)

public SessionInput.Builder setEvent(Event.Builder builderForValue)

Optional. Event input.

.google.cloud.ces.v1.Event event = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue Event.Builder
Returns
Type Description
SessionInput.Builder

setImage(Image value)

public SessionInput.Builder setImage(Image value)

Optional. Image data from the end user.

.google.cloud.ces.v1.Image image = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Image
Returns
Type Description
SessionInput.Builder

setImage(Image.Builder builderForValue)

public SessionInput.Builder setImage(Image.Builder builderForValue)

Optional. Image data from the end user.

.google.cloud.ces.v1.Image image = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue Image.Builder
Returns
Type Description
SessionInput.Builder

setText(String value)

public SessionInput.Builder setText(String value)

Optional. Text data from the end user.

string text = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The text to set.

Returns
Type Description
SessionInput.Builder

This builder for chaining.

setTextBytes(ByteString value)

public SessionInput.Builder setTextBytes(ByteString value)

Optional. Text data from the end user.

string text = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for text to set.

Returns
Type Description
SessionInput.Builder

This builder for chaining.

setToolResponses(ToolResponses value)

public SessionInput.Builder setToolResponses(ToolResponses value)

Optional. Execution results for the tool calls from the client.

.google.cloud.ces.v1.ToolResponses tool_responses = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ToolResponses
Returns
Type Description
SessionInput.Builder

setToolResponses(ToolResponses.Builder builderForValue)

public SessionInput.Builder setToolResponses(ToolResponses.Builder builderForValue)

Optional. Execution results for the tool calls from the client.

.google.cloud.ces.v1.ToolResponses tool_responses = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue ToolResponses.Builder
Returns
Type Description
SessionInput.Builder

setVariables(Struct value)

public SessionInput.Builder setVariables(Struct value)

Optional. Contextual variables for the session, keyed by name. Only variables declared in the app will be used by the CES agent.

Unrecognized variables will still be sent to the Dialogflow agent as additional session parameters.

.google.protobuf.Struct variables = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Struct
Returns
Type Description
SessionInput.Builder

setVariables(Struct.Builder builderForValue)

public SessionInput.Builder setVariables(Struct.Builder builderForValue)

Optional. Contextual variables for the session, keyed by name. Only variables declared in the app will be used by the CES agent.

Unrecognized variables will still be sent to the Dialogflow agent as additional session parameters.

.google.protobuf.Struct variables = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
SessionInput.Builder

setWillContinue(boolean value)

public SessionInput.Builder setWillContinue(boolean value)

Optional. A flag to indicate if the current message is a fragment of a larger input in the bidi streaming session. When true, the agent will defer processing until a subsequent message with will_continue set to false is received.

Note: This flag has no effect on audio and DTMF inputs, which are always processed in real-time.

bool will_continue = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The willContinue to set.

Returns
Type Description
SessionInput.Builder

This builder for chaining.