com.google.cloud.dialogflow.v2beta1

Class Context

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.dialogflow.v2beta1.Context

All Implemented Interfaces:

ContextOrBuilder, Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, Serializable

public final class Context
extends GeneratedMessageV3
implements ContextOrBuilder

 Dialogflow contexts are similar to natural language context. If a person says
 to you "they are orange", you need context in order to understand what "they"
 is referring to. Similarly, for Dialogflow to handle an end-user expression
 like that, it needs to be provided with context in order to correctly match
 an intent.
 Using contexts, you can control the flow of a conversation. You can configure
 contexts for an intent by setting input and output contexts, which are
 identified by string names. When an intent is matched, any configured output
 contexts for that intent become active. While any contexts are active,
 Dialogflow is more likely to match intents that are configured with input
 contexts that correspond to the currently active contexts.
 For more information about context, see the
 [Contexts guide](https://cloud.google.com/dialogflow/docs/contexts-overview).
 

Protobuf type google.cloud.dialogflow.v2beta1.Context

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Context.Builder Dialogflow contexts are similar to natural language context.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	LIFESPAN_COUNT_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	PARAMETERS_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static Context	getDefaultInstance()
Context	getDefaultInstanceForType()
static Descriptors.Descriptor	getDescriptor()
int	getLifespanCount() Optional.
String	getName() Required.
ByteString	getNameBytes() Required.
Struct	getParameters() Optional.
StructOrBuilder	getParametersOrBuilder() Optional.
Parser<Context>	getParserForType()
int	getSerializedSize()
UnknownFieldSet	getUnknownFields()
int	hashCode()
boolean	hasParameters() Optional.
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Context.Builder	newBuilder()
static Context.Builder	newBuilder(Context prototype)
Context.Builder	newBuilderForType()
protected Context.Builder	newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
static Context	parseDelimitedFrom(InputStream input)
static Context	parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static Context	parseFrom(byte[] data)
static Context	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static Context	parseFrom(ByteBuffer data)
static Context	parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
static Context	parseFrom(ByteString data)
static Context	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static Context	parseFrom(CodedInputStream input)
static Context	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static Context	parseFrom(InputStream input)
static Context	parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static Parser<Context>	parser()
Context.Builder	toBuilder()
void	writeTo(CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

LIFESPAN_COUNT_FIELD_NUMBER

public static final int LIFESPAN_COUNT_FIELD_NUMBER

See Also:

Constant Field Values

PARAMETERS_FIELD_NUMBER

public static final int PARAMETERS_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class GeneratedMessageV3

getUnknownFields

public final UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3

getName

public String getName()

 Required. The unique identifier of the context. Supported formats:
 - `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context
   ID>`,
 - `projects/<Project ID>/locations/<Location ID>/agent/sessions/<Session
   ID>/contexts/<Context ID>`,
 - `projects/<Project ID>/agent/environments/<Environment ID>/users/<User
   ID>/sessions/<Session ID>/contexts/<Context ID>`,
 - `projects/<Project ID>/locations/<Location
   ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session
   ID>/contexts/<Context ID>`,
 The `Context ID` is always converted to lowercase, may only contain
 characters in a-zA-Z0-9_-% and may be at most 250 bytes long.
 If `Environment ID` is not specified, we assume default 'draft'
 environment. If `User ID` is not specified, we assume default '-' user.
 The following context names are reserved for internal use by Dialogflow.
 You should not use these contexts or create contexts with these names:
 * `__system_counters__`
 * `*_id_dialog_context`
 * `*_dialog_params_size`
 

string name = 1;

Specified by:

getName in interface ContextOrBuilder

Returns:

The name.

getNameBytes

public ByteString getNameBytes()

 Required. The unique identifier of the context. Supported formats:
 - `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context
   ID>`,
 - `projects/<Project ID>/locations/<Location ID>/agent/sessions/<Session
   ID>/contexts/<Context ID>`,
 - `projects/<Project ID>/agent/environments/<Environment ID>/users/<User
   ID>/sessions/<Session ID>/contexts/<Context ID>`,
 - `projects/<Project ID>/locations/<Location
   ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session
   ID>/contexts/<Context ID>`,
 The `Context ID` is always converted to lowercase, may only contain
 characters in a-zA-Z0-9_-% and may be at most 250 bytes long.
 If `Environment ID` is not specified, we assume default 'draft'
 environment. If `User ID` is not specified, we assume default '-' user.
 The following context names are reserved for internal use by Dialogflow.
 You should not use these contexts or create contexts with these names:
 * `__system_counters__`
 * `*_id_dialog_context`
 * `*_dialog_params_size`
 

string name = 1;

Specified by:

getNameBytes in interface ContextOrBuilder

Returns:

The bytes for name.

getLifespanCount

public int getLifespanCount()

 Optional. The number of conversational query requests after which the
 context expires. The default is `0`. If set to `0`, the context expires
 immediately. Contexts expire automatically after 20 minutes if there
 are no matching queries.
 

int32 lifespan_count = 2;

Specified by:

getLifespanCount in interface ContextOrBuilder

Returns:

The lifespanCount.

hasParameters

public boolean hasParameters()

 Optional. The collection of parameters associated with this context.
 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: map
     -   Else: depending on parameter value type, could be one of string,
         number, boolean, null, list or map
 -   MapValue value:
     -   If parameter's entity type is a composite entity:
         map from composite entity property names to property values
     -   Else: parameter value
 

.google.protobuf.Struct parameters = 3;

Specified by:

hasParameters in interface ContextOrBuilder

Returns:

Whether the parameters field is set.

getParameters

public Struct getParameters()

 Optional. The collection of parameters associated with this context.
 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: map
     -   Else: depending on parameter value type, could be one of string,
         number, boolean, null, list or map
 -   MapValue value:
     -   If parameter's entity type is a composite entity:
         map from composite entity property names to property values
     -   Else: parameter value
 

.google.protobuf.Struct parameters = 3;

Specified by:

getParameters in interface ContextOrBuilder

Returns:

The parameters.

getParametersOrBuilder

public StructOrBuilder getParametersOrBuilder()

 Optional. The collection of parameters associated with this context.
 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: map
     -   Else: depending on parameter value type, could be one of string,
         number, boolean, null, list or map
 -   MapValue value:
     -   If parameter's entity type is a composite entity:
         map from composite entity property names to property values
     -   Else: parameter value
 

.google.protobuf.Struct parameters = 3;

Specified by:

getParametersOrBuilder in interface ContextOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3

writeTo

public void writeTo(CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface MessageLite

Overrides:

writeTo in class GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface MessageLite

Overrides:

getSerializedSize in class GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface Message

Overrides:

equals in class AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface Message

Overrides:

hashCode in class AbstractMessage

parseFrom

public static Context parseFrom(ByteBuffer data)
                         throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Context parseFrom(ByteBuffer data,
                                ExtensionRegistryLite extensionRegistry)
                         throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Context parseFrom(ByteString data)
                         throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Context parseFrom(ByteString data,
                                ExtensionRegistryLite extensionRegistry)
                         throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Context parseFrom(byte[] data)
                         throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Context parseFrom(byte[] data,
                                ExtensionRegistryLite extensionRegistry)
                         throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Context parseFrom(InputStream input)
                         throws IOException

Throws:

IOException

parseFrom

public static Context parseFrom(InputStream input,
                                ExtensionRegistryLite extensionRegistry)
                         throws IOException

Throws:

IOException

parseDelimitedFrom

public static Context parseDelimitedFrom(InputStream input)
                                  throws IOException

Throws:

IOException

parseDelimitedFrom

public static Context parseDelimitedFrom(InputStream input,
                                         ExtensionRegistryLite extensionRegistry)
                                  throws IOException

Throws:

IOException

parseFrom

public static Context parseFrom(CodedInputStream input)
                         throws IOException

Throws:

IOException

parseFrom

public static Context parseFrom(CodedInputStream input,
                                ExtensionRegistryLite extensionRegistry)
                         throws IOException

Throws:

IOException

newBuilderForType

public Context.Builder newBuilderForType()

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static Context.Builder newBuilder()

newBuilder

public static Context.Builder newBuilder(Context prototype)

toBuilder

public Context.Builder toBuilder()

Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected Context.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class GeneratedMessageV3

getDefaultInstance

public static Context getDefaultInstance()

parser

public static Parser<Context> parser()

getParserForType

public Parser<Context> getParserForType()

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessageV3

getDefaultInstanceForType

public Context getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder