Interface PageInfo.FormInfo.ParameterInfoOrBuilder (0.43.0)

public static interface PageInfo.FormInfo.ParameterInfoOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDisplayName()

public abstract String getDisplayName()

Always present for WebhookRequest. Required for 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
Type Description
String

The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

Always present for WebhookRequest. Required for 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
Type Description
ByteString

The bytes for displayName.

getJustCollected()

public abstract boolean getJustCollected()

Optional for WebhookRequest. Ignored for WebhookResponse. Indicates if the parameter value was just collected on the last conversation turn.

bool just_collected = 5;

Returns
Type Description
boolean

The justCollected.

getRequired()

public abstract boolean getRequired()

Optional for both WebhookRequest and 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
Type Description
boolean

The required.

getState()

public abstract PageInfo.FormInfo.ParameterInfo.ParameterState getState()

Always present for WebhookRequest. Required for WebhookResponse. The state of the parameter. This field can be set to INVALID by the webhook to invalidate the parameter; other values set by the webhook will be ignored.

.google.cloud.dialogflow.cx.v3.PageInfo.FormInfo.ParameterInfo.ParameterState state = 3;

Returns
Type Description
PageInfo.FormInfo.ParameterInfo.ParameterState

The state.

getStateValue()

public abstract int getStateValue()

Always present for WebhookRequest. Required for WebhookResponse. The state of the parameter. This field can be set to INVALID by the webhook to invalidate the parameter; other values set by the webhook will be ignored.

.google.cloud.dialogflow.cx.v3.PageInfo.FormInfo.ParameterInfo.ParameterState state = 3;

Returns
Type Description
int

The enum numeric value on the wire for state.

getValue()

public abstract Value getValue()

Optional for both WebhookRequest and 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
Type Description
Value

The value.

getValueOrBuilder()

public abstract ValueOrBuilder getValueOrBuilder()

Optional for both WebhookRequest and 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
Type Description
ValueOrBuilder

hasValue()

public abstract boolean hasValue()

Optional for both WebhookRequest and 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
Type Description
boolean

Whether the value field is set.