Class PageInfo.FormInfo.ParameterInfo (0.58.0)

public static final class PageInfo.FormInfo.ParameterInfo extends GeneratedMessageV3 implements PageInfo.FormInfo.ParameterInfoOrBuilder

Represents parameter information.

Protobuf type google.cloud.dialogflow.cx.v3.PageInfo.FormInfo.ParameterInfo

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > PageInfo.FormInfo.ParameterInfo

Static Fields

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

JUST_COLLECTED_FIELD_NUMBER

public static final int JUST_COLLECTED_FIELD_NUMBER
Field Value
Type Description
int

REQUIRED_FIELD_NUMBER

public static final int REQUIRED_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

VALUE_FIELD_NUMBER

public static final int VALUE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static PageInfo.FormInfo.ParameterInfo getDefaultInstance()
Returns
Type Description
PageInfo.FormInfo.ParameterInfo

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static PageInfo.FormInfo.ParameterInfo.Builder newBuilder()
Returns
Type Description
PageInfo.FormInfo.ParameterInfo.Builder

newBuilder(PageInfo.FormInfo.ParameterInfo prototype)

public static PageInfo.FormInfo.ParameterInfo.Builder newBuilder(PageInfo.FormInfo.ParameterInfo prototype)
Parameter
Name Description
prototype PageInfo.FormInfo.ParameterInfo
Returns
Type Description
PageInfo.FormInfo.ParameterInfo.Builder

parseDelimitedFrom(InputStream input)

public static PageInfo.FormInfo.ParameterInfo parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PageInfo.FormInfo.ParameterInfo
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PageInfo.FormInfo.ParameterInfo parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PageInfo.FormInfo.ParameterInfo
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static PageInfo.FormInfo.ParameterInfo parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
PageInfo.FormInfo.ParameterInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PageInfo.FormInfo.ParameterInfo parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PageInfo.FormInfo.ParameterInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PageInfo.FormInfo.ParameterInfo parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
PageInfo.FormInfo.ParameterInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PageInfo.FormInfo.ParameterInfo parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PageInfo.FormInfo.ParameterInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PageInfo.FormInfo.ParameterInfo parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
PageInfo.FormInfo.ParameterInfo
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PageInfo.FormInfo.ParameterInfo parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PageInfo.FormInfo.ParameterInfo
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static PageInfo.FormInfo.ParameterInfo parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PageInfo.FormInfo.ParameterInfo
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PageInfo.FormInfo.ParameterInfo parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PageInfo.FormInfo.ParameterInfo
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static PageInfo.FormInfo.ParameterInfo parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
PageInfo.FormInfo.ParameterInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PageInfo.FormInfo.ParameterInfo parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PageInfo.FormInfo.ParameterInfo
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<PageInfo.FormInfo.ParameterInfo> parser()
Returns
Type Description
Parser<ParameterInfo>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public PageInfo.FormInfo.ParameterInfo getDefaultInstanceForType()
Returns
Type Description
PageInfo.FormInfo.ParameterInfo

getDisplayName()

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

getParserForType()

public Parser<PageInfo.FormInfo.ParameterInfo> getParserForType()
Returns
Type Description
Parser<ParameterInfo>
Overrides

getRequired()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getState()

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

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public PageInfo.FormInfo.ParameterInfo.Builder newBuilderForType()
Returns
Type Description
PageInfo.FormInfo.ParameterInfo.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PageInfo.FormInfo.ParameterInfo.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
PageInfo.FormInfo.ParameterInfo.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public PageInfo.FormInfo.ParameterInfo.Builder toBuilder()
Returns
Type Description
PageInfo.FormInfo.ParameterInfo.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException