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

Class PageInfo.FormInfo.ParameterInfo

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.dialogflow.cx.v3beta1.PageInfo.FormInfo.ParameterInfo
All Implemented Interfaces:
PageInfo.FormInfo.ParameterInfoOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
PageInfo.FormInfo
public static final class PageInfo.FormInfo.ParameterInfo extends com.google.protobuf.GeneratedMessage implements PageInfo.FormInfo.ParameterInfoOrBuilder
 Represents parameter information.
Protobuf type google.cloud.dialogflow.cx.v3beta1.PageInfo.FormInfo.ParameterInfo
See Also:

  • 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

    • getDisplayName

      public String getDisplayName()
       Always present for
 [WebhookRequest][google.cloud.dialogflow.cx.v3beta1.WebhookRequest].
 Required for
 [WebhookResponse][google.cloud.dialogflow.cx.v3beta1.WebhookResponse].
 The human-readable name of the parameter, unique within the form. This
 field cannot be modified by the webhook.
      string display_name = 1;
      Specified by:
      getDisplayName in interface PageInfo.FormInfo.ParameterInfoOrBuilder
      Returns:
      The displayName.

    • getDisplayNameBytes

      public com.google.protobuf.ByteString getDisplayNameBytes()
       Always present for
 [WebhookRequest][google.cloud.dialogflow.cx.v3beta1.WebhookRequest].
 Required for
 [WebhookResponse][google.cloud.dialogflow.cx.v3beta1.WebhookResponse].
 The human-readable name of the parameter, unique within the form. This
 field cannot be modified by the webhook.
      string display_name = 1;
      Specified by:
      getDisplayNameBytes in interface PageInfo.FormInfo.ParameterInfoOrBuilder
      Returns:
      The bytes for displayName.

    • getRequired

      public boolean getRequired()
       Optional for both
 [WebhookRequest][google.cloud.dialogflow.cx.v3beta1.WebhookRequest] and
 [WebhookResponse][google.cloud.dialogflow.cx.v3beta1.WebhookResponse].
 Indicates whether the parameter is required. Optional parameters will
 not trigger prompts; however, they are filled if the user specifies
 them. Required parameters must be filled before form filling concludes.
      bool required = 2;
      Specified by:
      getRequired in interface PageInfo.FormInfo.ParameterInfoOrBuilder
      Returns:
      The required.

    • getStateValue

      public int getStateValue()
       Always present for
 [WebhookRequest][google.cloud.dialogflow.cx.v3beta1.WebhookRequest].
 Required for
 [WebhookResponse][google.cloud.dialogflow.cx.v3beta1.WebhookResponse].
 The state of the parameter. This field can be set to
 [INVALID][google.cloud.dialogflow.cx.v3beta1.PageInfo.FormInfo.ParameterInfo.ParameterState.INVALID]
 by the webhook to invalidate the parameter; other values set by the
 webhook will be ignored.
      .google.cloud.dialogflow.cx.v3beta1.PageInfo.FormInfo.ParameterInfo.ParameterState state = 3;
      Specified by:
      getStateValue in interface PageInfo.FormInfo.ParameterInfoOrBuilder
      Returns:
      The enum numeric value on the wire for state.

    • getState

      public PageInfo.FormInfo.ParameterInfo.ParameterState getState()
       Always present for
 [WebhookRequest][google.cloud.dialogflow.cx.v3beta1.WebhookRequest].
 Required for
 [WebhookResponse][google.cloud.dialogflow.cx.v3beta1.WebhookResponse].
 The state of the parameter. This field can be set to
 [INVALID][google.cloud.dialogflow.cx.v3beta1.PageInfo.FormInfo.ParameterInfo.ParameterState.INVALID]
 by the webhook to invalidate the parameter; other values set by the
 webhook will be ignored.
      .google.cloud.dialogflow.cx.v3beta1.PageInfo.FormInfo.ParameterInfo.ParameterState state = 3;
      Specified by:
      getState in interface PageInfo.FormInfo.ParameterInfoOrBuilder
      Returns:
      The state.

    • hasValue

      public boolean hasValue()
       Optional for both
 [WebhookRequest][google.cloud.dialogflow.cx.v3beta1.WebhookRequest] and
 [WebhookResponse][google.cloud.dialogflow.cx.v3beta1.WebhookResponse].
 The value of the parameter. This field can be set by the webhook to
 change the parameter value.
      .google.protobuf.Value value = 4;
      Specified by:
      hasValue in interface PageInfo.FormInfo.ParameterInfoOrBuilder
      Returns:
      Whether the value field is set.

    • getValue

      public com.google.protobuf.Value getValue()
       Optional for both
 [WebhookRequest][google.cloud.dialogflow.cx.v3beta1.WebhookRequest] and
 [WebhookResponse][google.cloud.dialogflow.cx.v3beta1.WebhookResponse].
 The value of the parameter. This field can be set by the webhook to
 change the parameter value.
      .google.protobuf.Value value = 4;
      Specified by:
      getValue in interface PageInfo.FormInfo.ParameterInfoOrBuilder
      Returns:
      The value.

    • getValueOrBuilder

      public com.google.protobuf.ValueOrBuilder getValueOrBuilder()
       Optional for both
 [WebhookRequest][google.cloud.dialogflow.cx.v3beta1.WebhookRequest] and
 [WebhookResponse][google.cloud.dialogflow.cx.v3beta1.WebhookResponse].
 The value of the parameter. This field can be set by the webhook to
 change the parameter value.
      .google.protobuf.Value value = 4;
      Specified by:
      getValueOrBuilder in interface PageInfo.FormInfo.ParameterInfoOrBuilder

    • getJustCollected

      public boolean getJustCollected()
       Optional for
 [WebhookRequest][google.cloud.dialogflow.cx.v3beta1.WebhookRequest].
 Ignored for
 [WebhookResponse][google.cloud.dialogflow.cx.v3beta1.WebhookResponse].
 Indicates if the parameter value was just collected on the last
 conversation turn.
      bool just_collected = 5;
      Specified by:
      getJustCollected in interface PageInfo.FormInfo.ParameterInfoOrBuilder
      Returns:
      The justCollected.

    • 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 PageInfo.FormInfo.ParameterInfo parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static PageInfo.FormInfo.ParameterInfo parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static PageInfo.FormInfo.ParameterInfo parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static PageInfo.FormInfo.ParameterInfo parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

      public static PageInfo.FormInfo.ParameterInfo parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static PageInfo.FormInfo.ParameterInfo.Builder newBuilder()

    • newBuilder

      public static PageInfo.FormInfo.ParameterInfo.Builder newBuilder(PageInfo.FormInfo.ParameterInfo prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static PageInfo.FormInfo.ParameterInfo getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<PageInfo.FormInfo.ParameterInfo> parser()

    • getParserForType

      public com.google.protobuf.Parser<PageInfo.FormInfo.ParameterInfo> 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 PageInfo.FormInfo.ParameterInfo getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder