Class Intent.Parameter (4.7.0)

public static final class Intent.Parameter extends GeneratedMessageV3 implements Intent.ParameterOrBuilder

Represents intent parameters.

Protobuf type google.cloud.dialogflow.v2.Intent.Parameter

Static Fields

DEFAULT_VALUE_FIELD_NUMBER

public static final int DEFAULT_VALUE_FIELD_NUMBER
Field Value
TypeDescription
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

ENTITY_TYPE_DISPLAY_NAME_FIELD_NUMBER

public static final int ENTITY_TYPE_DISPLAY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

IS_LIST_FIELD_NUMBER

public static final int IS_LIST_FIELD_NUMBER
Field Value
TypeDescription
int

MANDATORY_FIELD_NUMBER

public static final int MANDATORY_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

PROMPTS_FIELD_NUMBER

public static final int PROMPTS_FIELD_NUMBER
Field Value
TypeDescription
int

VALUE_FIELD_NUMBER

public static final int VALUE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Intent.Parameter getDefaultInstance()
Returns
TypeDescription
Intent.Parameter

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Intent.Parameter.Builder newBuilder()
Returns
TypeDescription
Intent.Parameter.Builder

newBuilder(Intent.Parameter prototype)

public static Intent.Parameter.Builder newBuilder(Intent.Parameter prototype)
Parameter
NameDescription
prototypeIntent.Parameter
Returns
TypeDescription
Intent.Parameter.Builder

parseDelimitedFrom(InputStream input)

public static Intent.Parameter parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Intent.Parameter
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Intent.Parameter parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Intent.Parameter
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Intent.Parameter parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Intent.Parameter
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Intent.Parameter parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Intent.Parameter
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Intent.Parameter parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Intent.Parameter
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Intent.Parameter parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Intent.Parameter
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Intent.Parameter parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Intent.Parameter
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Intent.Parameter parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Intent.Parameter
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Intent.Parameter parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Intent.Parameter
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Intent.Parameter parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Intent.Parameter
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Intent.Parameter parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Intent.Parameter
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Intent.Parameter parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Intent.Parameter
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Intent.Parameter> parser()
Returns
TypeDescription
Parser<Parameter>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public Intent.Parameter getDefaultInstanceForType()
Returns
TypeDescription
Intent.Parameter

getDefaultValue()

public String getDefaultValue()

Optional. The default value to use when the value yields an empty result. Default values can be extracted from contexts by using the following syntax: #context_name.parameter_name.

string default_value = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
String

The defaultValue.

getDefaultValueBytes()

public ByteString getDefaultValueBytes()

Optional. The default value to use when the value yields an empty result. Default values can be extracted from contexts by using the following syntax: #context_name.parameter_name.

string default_value = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ByteString

The bytes for defaultValue.

getDisplayName()

public String getDisplayName()

Required. The name of the parameter.

string display_name = 2;

Returns
TypeDescription
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Required. The name of the parameter.

string display_name = 2;

Returns
TypeDescription
ByteString

The bytes for displayName.

getEntityTypeDisplayName()

public String getEntityTypeDisplayName()

Optional. The name of the entity type, prefixed with @, that describes values of the parameter. If the parameter is required, this must be provided.

string entity_type_display_name = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
String

The entityTypeDisplayName.

getEntityTypeDisplayNameBytes()

public ByteString getEntityTypeDisplayNameBytes()

Optional. The name of the entity type, prefixed with @, that describes values of the parameter. If the parameter is required, this must be provided.

string entity_type_display_name = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ByteString

The bytes for entityTypeDisplayName.

getIsList()

public boolean getIsList()

Optional. Indicates whether the parameter represents a list of values.

bool is_list = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

The isList.

getMandatory()

public boolean getMandatory()

Optional. Indicates whether the parameter is required. That is, whether the intent cannot be completed without collecting the parameter value.

bool mandatory = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

The mandatory.

getName()

public String getName()

The unique identifier of this parameter.

string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

The unique identifier of this parameter.

string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<Intent.Parameter> getParserForType()
Returns
TypeDescription
Parser<Parameter>
Overrides

getPrompts(int index)

public String getPrompts(int index)

Optional. The collection of prompts that the agent can present to the user in order to collect a value for the parameter.

repeated string prompts = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The prompts at the given index.

getPromptsBytes(int index)

public ByteString getPromptsBytes(int index)

Optional. The collection of prompts that the agent can present to the user in order to collect a value for the parameter.

repeated string prompts = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the prompts at the given index.

getPromptsCount()

public int getPromptsCount()

Optional. The collection of prompts that the agent can present to the user in order to collect a value for the parameter.

repeated string prompts = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
int

The count of prompts.

getPromptsList()

public ProtocolStringList getPromptsList()

Optional. The collection of prompts that the agent can present to the user in order to collect a value for the parameter.

repeated string prompts = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ProtocolStringList

A list containing the prompts.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

getValue()

public String getValue()

Optional. The definition of the parameter value. It can be:

  • a constant string,
  • a parameter value defined as $parameter_name,
  • an original parameter value defined as $parameter_name.original,
  • a parameter value from some context defined as #context_name.parameter_name.

string value = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
String

The value.

getValueBytes()

public ByteString getValueBytes()

Optional. The definition of the parameter value. It can be:

  • a constant string,
  • a parameter value defined as $parameter_name,
  • an original parameter value defined as $parameter_name.original,
  • a parameter value from some context defined as #context_name.parameter_name.

string value = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ByteString

The bytes for value.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Intent.Parameter.Builder newBuilderForType()
Returns
TypeDescription
Intent.Parameter.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Intent.Parameter.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Intent.Parameter.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Intent.Parameter.Builder toBuilder()
Returns
TypeDescription
Intent.Parameter.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException