Class SessionInput (0.1.0)

public final class SessionInput extends GeneratedMessage implements SessionInputOrBuilder

Input for the session.

Protobuf type google.cloud.ces.v1.SessionInput

Static Fields

AUDIO_FIELD_NUMBER

public static final int AUDIO_FIELD_NUMBER
Field Value
Type Description
int

BLOB_FIELD_NUMBER

public static final int BLOB_FIELD_NUMBER
Field Value
Type Description
int

DTMF_FIELD_NUMBER

public static final int DTMF_FIELD_NUMBER
Field Value
Type Description
int

EVENT_FIELD_NUMBER

public static final int EVENT_FIELD_NUMBER
Field Value
Type Description
int

IMAGE_FIELD_NUMBER

public static final int IMAGE_FIELD_NUMBER
Field Value
Type Description
int

TEXT_FIELD_NUMBER

public static final int TEXT_FIELD_NUMBER
Field Value
Type Description
int

TOOL_RESPONSES_FIELD_NUMBER

public static final int TOOL_RESPONSES_FIELD_NUMBER
Field Value
Type Description
int

VARIABLES_FIELD_NUMBER

public static final int VARIABLES_FIELD_NUMBER
Field Value
Type Description
int

WILL_CONTINUE_FIELD_NUMBER

public static final int WILL_CONTINUE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SessionInput getDefaultInstance()
Returns
Type Description
SessionInput

getDescriptor()

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

newBuilder()

public static SessionInput.Builder newBuilder()
Returns
Type Description
SessionInput.Builder

newBuilder(SessionInput prototype)

public static SessionInput.Builder newBuilder(SessionInput prototype)
Parameter
Name Description
prototype SessionInput
Returns
Type Description
SessionInput.Builder

parseDelimitedFrom(InputStream input)

public static SessionInput parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SessionInput
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SessionInput parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SessionInput
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SessionInput parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SessionInput
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SessionInput parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SessionInput
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SessionInput parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SessionInput
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SessionInput parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SessionInput
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SessionInput parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SessionInput
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SessionInput parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SessionInput
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SessionInput parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SessionInput
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SessionInput parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SessionInput
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SessionInput parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SessionInput
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SessionInput parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SessionInput
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SessionInput> parser()
Returns
Type Description
Parser<SessionInput>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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.

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

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.

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.

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

getParserForType()

public Parser<SessionInput> getParserForType()
Returns
Type Description
Parser<SessionInput>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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.

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(AbstractMessage.BuilderParent parent)

protected SessionInput.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SessionInput.Builder
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException