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

Interface PageInfo.FormInfo.ParameterInfoOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
PageInfo.FormInfo.ParameterInfo, PageInfo.FormInfo.ParameterInfo.Builder
Enclosing class:
PageInfo.FormInfo
public static interface PageInfo.FormInfo.ParameterInfoOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDisplayName()
    Always present for [WebhookRequest][google.cloud.dialogflow.cx.v3beta1.WebhookRequest].
    com.google.protobuf.ByteString
    getDisplayNameBytes()
    Always present for [WebhookRequest][google.cloud.dialogflow.cx.v3beta1.WebhookRequest].
    boolean
    getJustCollected()
    Optional for [WebhookRequest][google.cloud.dialogflow.cx.v3beta1.WebhookRequest].
    boolean
    getRequired()
    Optional for both [WebhookRequest][google.cloud.dialogflow.cx.v3beta1.WebhookRequest] and [WebhookResponse][google.cloud.dialogflow.cx.v3beta1.WebhookResponse].
    PageInfo.FormInfo.ParameterInfo.ParameterState
    getState()
    Always present for [WebhookRequest][google.cloud.dialogflow.cx.v3beta1.WebhookRequest].
    int
    getStateValue()
    Always present for [WebhookRequest][google.cloud.dialogflow.cx.v3beta1.WebhookRequest].
    com.google.protobuf.Value
    getValue()
    Optional for both [WebhookRequest][google.cloud.dialogflow.cx.v3beta1.WebhookRequest] and [WebhookResponse][google.cloud.dialogflow.cx.v3beta1.WebhookResponse].
    com.google.protobuf.ValueOrBuilder
    getValueOrBuilder()
    Optional for both [WebhookRequest][google.cloud.dialogflow.cx.v3beta1.WebhookRequest] and [WebhookResponse][google.cloud.dialogflow.cx.v3beta1.WebhookResponse].
    boolean
    hasValue()
    Optional for both [WebhookRequest][google.cloud.dialogflow.cx.v3beta1.WebhookRequest] and [WebhookResponse][google.cloud.dialogflow.cx.v3beta1.WebhookResponse].

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getDisplayName

      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;
      Returns:
      The displayName.

    • getDisplayNameBytes

      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;
      Returns:
      The bytes for displayName.

    • getRequired

      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;
      Returns:
      The required.

    • getStateValue

      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;
      Returns:
      The enum numeric value on the wire for state.

    • getState

      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;
      Returns:
      The state.

    • hasValue

      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;
      Returns:
      Whether the value field is set.

    • getValue

      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;
      Returns:
      The value.

    • getValueOrBuilder

      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;

    • getJustCollected

      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;
      Returns:
      The justCollected.