Package com.google.cloud.dialogflow.cx.v3beta1

Class Match

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.dialogflow.cx.v3beta1.Match
All Implemented Interfaces:
MatchOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class Match extends com.google.protobuf.GeneratedMessage implements MatchOrBuilder
 Represents one match result of [MatchIntent][].
Protobuf type google.cloud.dialogflow.cx.v3beta1.Match
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Match.Builder
    Represents one match result of [MatchIntent][].
    static enum 
    Match.MatchType
    Type of a Match.

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

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

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

    com.google.protobuf.AbstractMessage.BuilderParent

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

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    CONFIDENCE_FIELD_NUMBER
     
    static final int
    EVENT_FIELD_NUMBER
     
    static final int
    INTENT_FIELD_NUMBER
     
    static final int
    MATCH_TYPE_FIELD_NUMBER
     
    static final int
    PARAMETERS_FIELD_NUMBER
     
    static final int
    RESOLVED_INPUT_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, 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
    Description
    boolean
    equals(Object obj)
     
    float
    getConfidence()
    The confidence of this match.
    static Match
    getDefaultInstance()
     
    Match
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getEvent()
    The event that matched the query.
    com.google.protobuf.ByteString
    getEventBytes()
    The event that matched the query.
    Intent
    getIntent()
    The [Intent][google.cloud.dialogflow.cx.v3beta1.Intent] that matched the query.
    IntentOrBuilder
    getIntentOrBuilder()
    The [Intent][google.cloud.dialogflow.cx.v3beta1.Intent] that matched the query.
    Match.MatchType
    getMatchType()
    Type of this [Match][google.cloud.dialogflow.cx.v3beta1.Match].
    int
    getMatchTypeValue()
    Type of this [Match][google.cloud.dialogflow.cx.v3beta1.Match].
    com.google.protobuf.Struct
    getParameters()
    The collection of parameters extracted from the query.
    com.google.protobuf.StructOrBuilder
    getParametersOrBuilder()
    The collection of parameters extracted from the query.
    com.google.protobuf.Parser<Match>
    getParserForType()
     
    String
    getResolvedInput()
    Final text input which was matched during MatchIntent.
    com.google.protobuf.ByteString
    getResolvedInputBytes()
    Final text input which was matched during MatchIntent.
    int
    getSerializedSize()
     
    int
    hashCode()
     
    boolean
    hasIntent()
    The [Intent][google.cloud.dialogflow.cx.v3beta1.Intent] that matched the query.
    boolean
    hasParameters()
    The collection of parameters extracted from the query.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Match.Builder
    newBuilder()
     
    static Match.Builder
    newBuilder(Match prototype)
     
    Match.Builder
    newBuilderForType()
     
    protected Match.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static Match
    parseDelimitedFrom(InputStream input)
     
    static Match
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Match
    parseFrom(byte[] data)
     
    static Match
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Match
    parseFrom(com.google.protobuf.ByteString data)
     
    static Match
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Match
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Match
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Match
    parseFrom(InputStream input)
     
    static Match
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Match
    parseFrom(ByteBuffer data)
     
    static Match
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Match>
    parser()
     
    Match.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, 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, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    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.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • hasIntent

      public boolean hasIntent()
       The [Intent][google.cloud.dialogflow.cx.v3beta1.Intent] that matched the
 query. Some, not all fields are filled in this message, including but not
 limited to: `name` and `display_name`. Only filled for
 [`INTENT`][google.cloud.dialogflow.cx.v3beta1.Match.MatchType] match type.
      .google.cloud.dialogflow.cx.v3beta1.Intent intent = 1;
      Specified by:
      hasIntent in interface MatchOrBuilder
      Returns:
      Whether the intent field is set.

    • getIntent

      public Intent getIntent()
       The [Intent][google.cloud.dialogflow.cx.v3beta1.Intent] that matched the
 query. Some, not all fields are filled in this message, including but not
 limited to: `name` and `display_name`. Only filled for
 [`INTENT`][google.cloud.dialogflow.cx.v3beta1.Match.MatchType] match type.
      .google.cloud.dialogflow.cx.v3beta1.Intent intent = 1;
      Specified by:
      getIntent in interface MatchOrBuilder
      Returns:
      The intent.

    • getIntentOrBuilder

      public IntentOrBuilder getIntentOrBuilder()
       The [Intent][google.cloud.dialogflow.cx.v3beta1.Intent] that matched the
 query. Some, not all fields are filled in this message, including but not
 limited to: `name` and `display_name`. Only filled for
 [`INTENT`][google.cloud.dialogflow.cx.v3beta1.Match.MatchType] match type.
      .google.cloud.dialogflow.cx.v3beta1.Intent intent = 1;
      Specified by:
      getIntentOrBuilder in interface MatchOrBuilder

    • getEvent

      public String getEvent()
       The event that matched the query. Filled for
 [`EVENT`][google.cloud.dialogflow.cx.v3beta1.Match.MatchType],
 [`NO_MATCH`][google.cloud.dialogflow.cx.v3beta1.Match.MatchType] and
 [`NO_INPUT`][google.cloud.dialogflow.cx.v3beta1.Match.MatchType] match
 types.
      string event = 6;
      Specified by:
      getEvent in interface MatchOrBuilder
      Returns:
      The event.

    • getEventBytes

      public com.google.protobuf.ByteString getEventBytes()
       The event that matched the query. Filled for
 [`EVENT`][google.cloud.dialogflow.cx.v3beta1.Match.MatchType],
 [`NO_MATCH`][google.cloud.dialogflow.cx.v3beta1.Match.MatchType] and
 [`NO_INPUT`][google.cloud.dialogflow.cx.v3beta1.Match.MatchType] match
 types.
      string event = 6;
      Specified by:
      getEventBytes in interface MatchOrBuilder
      Returns:
      The bytes for event.

    • hasParameters

      public boolean hasParameters()
       The collection of parameters extracted from the query.

 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;
      Specified by:
      hasParameters in interface MatchOrBuilder
      Returns:
      Whether the parameters field is set.

    • getParameters

      public com.google.protobuf.Struct getParameters()
       The collection of parameters extracted from the query.

 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;
      Specified by:
      getParameters in interface MatchOrBuilder
      Returns:
      The parameters.

    • getParametersOrBuilder

      public com.google.protobuf.StructOrBuilder getParametersOrBuilder()
       The collection of parameters extracted from the query.

 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;
      Specified by:
      getParametersOrBuilder in interface MatchOrBuilder

    • getResolvedInput

      public String getResolvedInput()
       Final text input which was matched during MatchIntent. This value can be
 different from original input sent in request because of spelling
 correction or other processing.
      string resolved_input = 3;
      Specified by:
      getResolvedInput in interface MatchOrBuilder
      Returns:
      The resolvedInput.

    • getResolvedInputBytes

      public com.google.protobuf.ByteString getResolvedInputBytes()
       Final text input which was matched during MatchIntent. This value can be
 different from original input sent in request because of spelling
 correction or other processing.
      string resolved_input = 3;
      Specified by:
      getResolvedInputBytes in interface MatchOrBuilder
      Returns:
      The bytes for resolvedInput.

    • getMatchTypeValue

      public int getMatchTypeValue()
       Type of this [Match][google.cloud.dialogflow.cx.v3beta1.Match].
      .google.cloud.dialogflow.cx.v3beta1.Match.MatchType match_type = 4;
      Specified by:
      getMatchTypeValue in interface MatchOrBuilder
      Returns:
      The enum numeric value on the wire for matchType.

    • getMatchType

      public Match.MatchType getMatchType()
       Type of this [Match][google.cloud.dialogflow.cx.v3beta1.Match].
      .google.cloud.dialogflow.cx.v3beta1.Match.MatchType match_type = 4;
      Specified by:
      getMatchType in interface MatchOrBuilder
      Returns:
      The matchType.

    • getConfidence

      public float getConfidence()
       The confidence of this match. Values range from 0.0 (completely uncertain)
 to 1.0 (completely certain).
 This value is for informational purpose only and is only used to help match
 the best intent within the classification threshold. This value may change
 for the same end-user expression at any time due to a model retraining or
 change in implementation.
      float confidence = 5;
      Specified by:
      getConfidence in interface MatchOrBuilder
      Returns:
      The confidence.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Match parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Match parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Match parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Match parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Match parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Match parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Match parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Match parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Match parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Match parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Match parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Match parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Match.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Match.Builder newBuilder()

    • newBuilder

      public static Match.Builder newBuilder(Match prototype)

    • toBuilder

      public Match.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Match.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Match getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Match> parser()

    • getParserForType

      public com.google.protobuf.Parser<Match> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public Match getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder